ComplexMatrixInPlaceApply Method

Evaluates the specified function at each entry of this instance, and substitutes each entry with its corresponding function value.

Definition

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

C#

public void InPlaceApply(
	Func<Complex, Complex> func
)

VB

Public Sub InPlaceApply ( 
	func As Func(Of Complex, Complex)
)

C++

public:
void InPlaceApply(
	Func<Complex, Complex>^ func
)

F#

member InPlaceApply : 
        func : Func<Complex, Complex> -> unit

Parameters

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

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 InPlaceApply(FuncComplex, Complex) transforms by setting

Example

In the following example, the entries in a matrix are all squared.

C#

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexInPlaceApplyExample0  
    {
        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("Initial data matrix:");
            Console.WriteLine(matrix);

            // Square all matrix entries.
            matrix.InPlaceApply((x) => x*x);

            Console.WriteLine();
            Console.WriteLine("Matrix transformed by squaring its entries:");
            Console.WriteLine(matrix);
        }
    }
}

// Executing method Main() produces the following output:
// 
// Initial data matrix:
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// 
// 
// 
// Matrix transformed by squaring its entries:
// (                0,               -2) (                0,              -50) 
// (                0,               -8) (                0,              -72) 
// (                0,              -18) (                0,              -98) 
// 
//

Exceptions

ArgumentNullException

func is null.