Click or drag to resize

ComplexMatrixSubtract Method (ComplexMatrix, Complex)

Determines the subtraction of a scalar from a matrix.

Namespace:  Novacta.Analytics
Assembly:  Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntax
public static ComplexMatrix Subtract(
	ComplexMatrix left,
	Complex right
)

Parameters

left
Type: Novacta.AnalyticsComplexMatrix
The left operand.
right
Type: System.NumericsComplex
The right operand.

Return Value

Type: ComplexMatrix
The result of subtracting right from 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 scalar is subtracted from a matrix.

C#
using System;
using System.Numerics;

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

            // Create the right operand.
            Complex right = new(8, -8);
            Console.WriteLine("right =");
            Console.WriteLine(right);

            // Subtract right from left.
            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 Subtract.
            result = ComplexMatrix.Subtract(left, right);

            Console.WriteLine();
            Console.WriteLine("ComplexMatrix.Subtract(left, right) returns");
            Console.WriteLine();
            Console.WriteLine(result);

            // Both operators and alternative methods are overloaded to 
            // support read-only matrix arguments.
            // Compute the subtraction 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) 
// (                4,               -4) (                8,               -8) 
// 
// 
// right =
// (8, -8)
// 
// left - right =
// (               -7,                7) (               -3,                3) 
// (               -6,                6) (               -2,                2) 
// (               -5,                5) (               -1,                1) 
// (               -4,                4) (                0,                0) 
// 
// 
// 
// ComplexMatrix.Subtract(left, right) returns
// 
// (               -7,                7) (               -3,                3) 
// (               -6,                6) (               -2,                2) 
// (               -5,                5) (               -1,                1) 
// (               -4,                4) (                0,                0) 
// 
// 
// 
// readOnlyLeft - right =
// (               -7,                7) (               -3,                3) 
// (               -6,                6) (               -2,                2) 
// (               -5,                5) (               -1,                1) 
// (               -4,                4) (                0,                0) 
// 

See Also