Click or drag to resize

DoubleMatrixElementWiseMultiply Method

Determines the element wise product of two matrices.

Namespace:  Novacta.Analytics
Assembly:  Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntax
Copy
public static DoubleMatrix ElementWiseMultiply(
	DoubleMatrix left,
	DoubleMatrix right
)

Parameters

left
Type: Novacta.AnalyticsDoubleMatrix
The left operand.
right
Type: Novacta.AnalyticsDoubleMatrix
The right operand.

Return Value

Type: DoubleMatrix
The result of element wise multiplying left by right.
Exceptions
ExceptionCondition
ArgumentNullExceptionleft is null.
-or-
right is null.
ArgumentExceptionleft and right have not the same number of rows and columns.
Remarks

Let LaTeX equation and LaTeX equation be the left number of rows and columns, respectively, and consider its generic entry

LaTeX equation

Analogously, Let LaTeX equation and LaTeX equation be the right number of rows and columns, respectively, and let its generic entry given by

LaTeX equation

The method returns a matrix whose generic entry is

LaTeX equation

provided that the dimensions of left agree with those of right; otherwise, an exception is thrown.

Examples

In the following example, some matrices are element wise multiplied.

C#
Copy
using System;

namespace Novacta.Analytics.CodeExamples
{
    public class ElementWiseMultiplyExample0  
    {
        public void Main()
        {
            // Create the left operand.
            var data = new double[6] {
                0,  2, 4,
                1,  3, 5
            };
            var left = DoubleMatrix.Dense(2, 3, data, StorageOrder.RowMajor);
            Console.WriteLine("left =");
            Console.WriteLine(left);

            // Create the right operand.
            data = new double[6] {
                0,  20,  40,
               10,  30,  50
            };
            var right = DoubleMatrix.Dense(2, 3, data, StorageOrder.RowMajor);
            Console.WriteLine("right =");
            Console.WriteLine(right);

            // Element wise multiply left by right.
            var result = DoubleMatrix.ElementWiseMultiply(left, right);

            Console.WriteLine();
            Console.WriteLine("Element wise multiplication: left * right =");
            Console.WriteLine(result);

            // Class ReadOnlyDoubleMatrix supports element wise multiplications
            // where some arguments are read-only matrices.
            // Compute the product using a read-only wrapper of left.
            ReadOnlyDoubleMatrix readOnlyLeft = left.AsReadOnly();
            result = ReadOnlyDoubleMatrix.ElementWiseMultiply(readOnlyLeft, right);

            Console.WriteLine();
            Console.WriteLine("Element wise multiplication: readOnlyLeft * right =");
            Console.WriteLine(result);
        }
    }
}

// Executing method Main() produces the following output:
// 
// left =
// 0                2                4                
// 1                3                5                
// 
// 
// right =
// 0                20               40               
// 10               30               50               
// 
// 
// 
// Element wise multiplication: left * right =
// 0                40               160              
// 10               90               250              
// 
// 
// 
// Element wise multiplication: readOnlyLeft * right =
// 0                40               160              
// 10               90               250              
//

See Also