ComplexMatrixAdd(ComplexMatrix, Complex) Method

Determines the addition of a matrix to a scalar.

Definition

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

public static ComplexMatrix Add(
	ComplexMatrix left,
	Complex right
)

Public Shared Function Add ( 
	left As ComplexMatrix,
	right As Complex
) As ComplexMatrix

C++

public:
static ComplexMatrix^ Add(
	ComplexMatrix^ left, 
	Complex right
)

static member Add : 
        left : ComplexMatrix * 
        right : Complex -> ComplexMatrix

Parameters

left ComplexMatrix: The left operand.
right Complex: The right operand.

Return Value

ComplexMatrix
The result of adding left to right.

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 added to a scalar.

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexAdditionExample1  
    {
        public void Main()
        {
            // Create the left operand.
            var data = new Complex[6] {
                new(1, -1), new(5, -5),
                new(2, -2), new(6, -6),
                new(3, -3), new(7, -7)
            };
            var left = ComplexMatrix.Dense(3, 2, data, StorageOrder.RowMajor);
            Console.WriteLine("left =");
            Console.WriteLine(left);

            // Create the right operand.
            Complex right = new(7, -7);
            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 = ComplexMatrix.Add(left, right);

            Console.WriteLine();
            Console.WriteLine("ComplexMatrix.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 left.
            ReadOnlyComplexMatrix readOnlyLeft = left.AsReadOnly();
            result = readOnlyLeft + right;

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

// Executing method Main() produces the following output:
// 
// left =
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// 
// 
// right =
// <7; -7>
// 
// left + right =
// (                8,               -8) (               12,              -12) 
// (                9,               -9) (               13,              -13) 
// (               10,              -10) (               14,              -14) 
// 
// 
// 
// ComplexMatrix.Add(left, right) returns
// 
// (                8,               -8) (               12,              -12) 
// (                9,               -9) (               13,              -13) 
// (               10,              -10) (               14,              -14) 
// 
// 
// 
// readOnlyLeft + right =
// (                8,               -8) (               12,              -12) 
// (                9,               -9) (               13,              -13) 
// (               10,              -10) (               14,              -14) 
// 
//

Exceptions

ArgumentNullException

left is null.