ComplexMatrixAddition(Complex, ComplexMatrix) Operator

Determines the addition of a scalar to a matrix.

Definition

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

public static ComplexMatrix operator +(
	Complex left,
	ComplexMatrix right
)

Public Shared Operator + ( 
	left As Complex,
	right As ComplexMatrix
) As ComplexMatrix

C++

public:
static ComplexMatrix^ operator +(
	Complex left, 
	ComplexMatrix^ right
)

static let inline (+)
        left : Complex * 
        right : ComplexMatrix  : ComplexMatrix

Parameters

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

Return Value

ComplexMatrix
The result of adding left to right.

Remarks

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

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

LaTeX equation

Example

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

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexAdditionExample2  
    {
        public void Main()
        {
            // Create the left operand.
            Complex left = new(7, -7);
            Console.WriteLine("left =");
            Console.WriteLine(left);
            Console.WriteLine();

            // Create the right 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 right = ComplexMatrix.Dense(3, 2, 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 = 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 right.
            ReadOnlyComplexMatrix readOnlyRight = right.AsReadOnly();
            result = left + readOnlyRight;

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

// Executing method Main() produces the following output:
// 
// left =
// <7; -7>
// 
// right =
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                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) 
// 
// 
// 
// left + readOnlyRight =
// (                8,               -8) (               12,              -12) 
// (                9,               -9) (               13,              -13) 
// (               10,              -10) (               14,              -14) 
// 
//

Exceptions

ArgumentNullException

right is null.