ComplexMatrixNegate Method

Determines the negation of a matrix.

Definition

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

public static ComplexMatrix Negate(
	ComplexMatrix matrix
)

Public Shared Function Negate ( 
	matrix As ComplexMatrix
) As ComplexMatrix

C++

public:
static ComplexMatrix^ Negate(
	ComplexMatrix^ matrix
)

static member Negate : 
        matrix : ComplexMatrix -> ComplexMatrix

Parameters

matrix ComplexMatrix: The operand.

Return Value

ComplexMatrix
The result of negating matrix.

Remarks

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

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

LaTeX equation

Example

In the following example, some matrices are negated.

using System;
using System.Numerics;

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

            // Compute the negation of operand.
            var result = -operand;

            Console.WriteLine();
            Console.WriteLine("- operand =");
            Console.WriteLine(result);

            // In .NET languages that do not support overloaded operators,
            // you can use the alternative methods named Negate.
            result = ComplexMatrix.Negate(operand);

            Console.WriteLine();
            Console.WriteLine("DoubleMatrix.Negate(operand) returns");
            Console.WriteLine();
            Console.WriteLine(result);

            // Both operators and alternative methods are overloaded to 
            // support read-only matrix arguments.
            // Compute the negation using a read-only wrapper of operand.
            ReadOnlyComplexMatrix readOnlyOperand = operand.AsReadOnly();
            result = -readOnlyOperand;

            Console.WriteLine();
            Console.WriteLine("- readOnlyOperand =");
            Console.WriteLine(result);
        }
    }
}

// Executing method Main() produces the following output:
// 
// operand =
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// (                4,               -4) (                8,               -8) 
// 
// 
// 
// - operand =
// (               -1,                1) (               -5,                5) 
// (               -2,                2) (               -6,                6) 
// (               -3,                3) (               -7,                7) 
// (               -4,                4) (               -8,                8) 
// 
// 
// 
// DoubleMatrix.Negate(operand) returns
// 
// (               -1,                1) (               -5,                5) 
// (               -2,                2) (               -6,                6) 
// (               -3,                3) (               -7,                7) 
// (               -4,                4) (               -8,                8) 
// 
// 
// 
// - readOnlyOperand =
// (               -1,                1) (               -5,                5) 
// (               -2,                2) (               -6,                6) 
// (               -3,                3) (               -7,                7) 
// (               -4,                4) (               -8,                8) 
// 
//

Exceptions

ArgumentNullException

matrix is null.