Click or drag to resize

DoubleMatrixAdd Method (Double, DoubleMatrix)

Determines the addition of a scalar to a matrix.

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

Parameters

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

Return Value

Type: DoubleMatrix
The result of adding left to right.
Exceptions
ExceptionCondition
ArgumentNullExceptionright is null.
Remarks

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 having the same dimensions of right, whose generic entry is:

LaTeX equation

Examples

In the following example, a scalar is added to a matrix.

C#
using System;

namespace Novacta.Analytics.CodeExamples
{
    public class AdditionExample2  
    {
        public void Main()
        {
            // Create the left operand.
            double left = 10.0;
            Console.WriteLine("left =");
            Console.WriteLine(left);
            Console.WriteLine();

            // Create the right operand.
            var 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);

            // Compute the sum of left and 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 Add.
            result = DoubleMatrix.Add(left, right);

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

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

            Console.WriteLine();
            Console.WriteLine("left + readOnlyRight =");
            Console.WriteLine(result);
        }
    }
}

// Executing method Main() produces the following output:
// 
// left =
// 10
// 
// right =
// 0                20               40               
// 10               30               50               
// 
// 
// 
// left + right =
// 10               30               50               
// 20               40               60               
// 
// 
// 
// DoubleMatrix.Add(left, right) returns
// 
// 10               30               50               
// 20               40               60               
// 
// 
// 
// left + readOnlyRight =
// 10               30               50               
// 20               40               60               
// 

See Also