DoubleMatrixMultiply(DoubleMatrix, Double) Operator

Determines the multiplication of a matrix by a scalar.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a

C#

public static DoubleMatrix operator *(
	DoubleMatrix left,
	double right
)

VB

Public Shared Operator * ( 
	left As DoubleMatrix,
	right As Double
) As DoubleMatrix

C++

public:
static DoubleMatrix^ operator *(
	DoubleMatrix^ left, 
	double right
)

F#

static let inline (*)
        left : DoubleMatrix * 
        right : float  : DoubleMatrix

Parameters

left DoubleMatrix: The left operand.
right Double: The right operand.

Return Value

DoubleMatrix
The result of multiplying right by left.

Remarks

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

The method returns a matrix having the same dimensions of left, whose generic entry is:

LaTeX equation

Example

In the following example, a matrix is multiplied by a scalar.

C#

using System;

namespace Novacta.Analytics.CodeExamples
{
    public class MultiplicationExample1  
    {
        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.
            double right = 10.0;
            Console.WriteLine("right =");
            Console.WriteLine(right);

            // Multiply left by right.
            var result = left * right;

            Console.WriteLine();
            Console.WriteLine("left * right =");
            Console.WriteLine(result);

            // In .NET languages that do not support overloaded operators,
            // you can use the alternative methods named Multiply.
            result = DoubleMatrix.Multiply(left, right);

            Console.WriteLine();
            Console.WriteLine("DoubleMatrix.Multiply(left, right) returns");
            Console.WriteLine();
            Console.WriteLine(result);

            // Both operators and alternative methods are overloaded to 
            // support read-only matrix arguments.
            // Compute the product using a read-only wrapper of left.
            ReadOnlyDoubleMatrix readOnlyLeft = left.AsReadOnly();
            result = readOnlyLeft * right;

            Console.WriteLine();
            Console.WriteLine("readOnlyLeft * right =");
            Console.WriteLine(result);
        }
    }
}

// Executing method Main() produces the following output:
// 
// left =
// 0                2                4                
// 1                3                5                
// 
// 
// right =
// 10
// 
// left * right =
// 0                20               40               
// 10               30               50               
// 
// 
// 
// DoubleMatrix.Multiply(left, right) returns
// 
// 0                20               40               
// 10               30               50               
// 
// 
// 
// readOnlyLeft * right =
// 0                20               40               
// 10               30               50               
// 
//

Exceptions

ArgumentNullException

left is null.