ComplexMatrixFindWhile Method

Searches for entries in this instance that matches the conditions defined by the specified predicate, and returns their zero-based linear indexes.

Definition

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

C#

public IndexCollection FindWhile(
	Predicate<Complex> match
)

VB

Public Function FindWhile ( 
	match As Predicate(Of Complex)
) As IndexCollection

C++

public:
IndexCollection^ FindWhile(
	Predicate<Complex>^ match
)

F#

member FindWhile : 
        match : Predicate<Complex> -> IndexCollection

Parameters

match PredicateComplex: The predicate that defines the conditions of the entries to search for.

Return Value

IndexCollection
The collection of zero-based linear indexes of the entries that matches the conditions defined by match, if found; otherwise null.

Remarks

Matrix entries are interpreted as well ordered following a column major ordering. The position of an entry in such well ordering is referred to as the linear position of that entry.

Example

In the following example, the negative entries of a data matrix are found.

C#

using System;
using System.Numerics;

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

            // Match entries having magnitude less than 2.
            static bool match(Complex value) { return value.Magnitude < 2.0; }

            // Find the linear indexes of matched entries in data.
            var indexes = matrix.FindWhile(match);

            Console.WriteLine();
            Console.WriteLine("Linear indexes of matched entries in data:");
            Console.WriteLine(indexes);

            // FindWhile is available for read-only matrices:
            // find matched entries using a read-only wrapper of the data matrix.
            ReadOnlyComplexMatrix readOnlyMatrix = matrix.AsReadOnly();
            indexes = readOnlyMatrix.FindWhile(match);

            Console.WriteLine();
            Console.WriteLine("Using read-only data. Linear indexes of matched entries:");
            Console.WriteLine(indexes);
        }
    }
}

// Executing method Main() produces the following output:
// 
// The data matrix:
// (                0,                0) (                5,               -5) 
// (                2,               -2) (                0,                0) 
// (                0,                0) (                2,               -2) 
// 
// 
// 
// Linear indexes of matched entries in data:
// 0, 2, 4
// 
// Using read-only data. Linear indexes of matched entries:
// 0, 2, 4

Exceptions

ArgumentNullException

match is null.