ComplexMatrixApply Method

Evaluates the specified function at each entry of this instance, and returns a matrix whose entries are given by the corresponding function values.

Definition

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

C#

public ComplexMatrix Apply(
	Func<Complex, Complex> func
)

VB

Public Function Apply ( 
	func As Func(Of Complex, Complex)
) As ComplexMatrix

C++

public:
ComplexMatrix^ Apply(
	Func<Complex, Complex>^ func
)

F#

member Apply : 
        func : Func<Complex, Complex> -> ComplexMatrix

Parameters

func FuncComplex, Complex: The function to apply to each matrix entry.

Return Value

ComplexMatrix
A matrix whose entries are given by the values the specified function takes on at the entries of this instance.

Remarks

Let LaTeX equation be a matrix, and consider its generic entry

where and are the number of rows and columns of , respectively.

Let LaTeX equation the function represented by func. Then method Apply(FuncComplex, Complex) returns a matrix, say , having the same dimensions of by setting

Example

In the following example, a new matrix is built by squaring all the entries in a given matrix.

C#

using System;
using System.Numerics;

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

            // Return a matrix obtained by adding 1 to each entry
            // of the initial matrix.
            var plusOneMatrix = matrix.Apply((x) => x + 1);

            Console.WriteLine();
            Console.WriteLine("Matrix obtained by adding 1 to each entry:");
            Console.WriteLine(plusOneMatrix);

            // Add one using a read-only wrapper of the data matrix.
            ReadOnlyComplexMatrix readOnlyMatrix = matrix.AsReadOnly();
            var plusOneReadOnlyMatrix = readOnlyMatrix.Apply((x) => x + 1);

            Console.WriteLine();
            Console.WriteLine("Adding 1 to each entry of a read only matrix:");
            Console.WriteLine(plusOneReadOnlyMatrix);
        }
    }
}

// Executing method Main() produces the following output:
// 
// The data matrix:
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// 
// 
// 
// Matrix obtained by adding 1 to each entry:
// (                2,               -1) (                6,               -5) 
// (                3,               -2) (                7,               -6) 
// (                4,               -3) (                8,               -7) 
// 
// 
// 
// Adding 1 to each entry of a read only matrix:
// (                2,               -1) (                6,               -5) 
// (                3,               -2) (                7,               -6) 
// (                4,               -3) (                8,               -7) 
// 
//

Exceptions

ArgumentNullException

func is null.