Click or drag to resize

DoubleMatrixMultiply Method (DoubleMatrix, Double)

Determines the multiplication of a matrix by a scalar.

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

Parameters

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

Return Value

Type: DoubleMatrix
The result of multiplying right by left.
Exceptions
ExceptionCondition
ArgumentNullExceptionleft is null.
Remarks

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

LaTeX equation

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

LaTeX equation

Examples

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               
// 

See Also