ComplexMatrixItem(Int32) Property

Gets or sets the element of this instance corresponding to the specified linear index.

Definition

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

C#

public Complex this[
	int linearIndex
] { get; set; }

VB

Public Default Property Item ( 
	linearIndex As Integer
) As Complex
	Get
	Set

C++

public:
virtual property Complex default[int linearIndex] {
	Complex get (int linearIndex) sealed;
	void set (int linearIndex, Complex value) sealed;
}

F#

abstract Item : Complex with get, set
override Item : Complex with get, set

Parameters

linearIndex Int32: The zero-based linear index of the element to get or set.

Property Value

Complex
The element corresponding to the specified linear index.

Implements

IListTItemInt32
IReadOnlyListTItemInt32

Remarks

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

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

A linear index completely identifies an entry, assuming that entries are linearly ordered following the ColumnMajor data order. This means that entry LaTeX equation has linear index equal to , and matrix entries can be enumerated as follows:

where is the Count of the matrix.

Example

In the following example, a matrix element is accessed using its linear index.

C#

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexLinearIndexerExample0  
    {
        public void Main()
        {
            // Create a matrix.
            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 matrix = ComplexMatrix.Dense(4, 2, data, StorageOrder.RowMajor);
            Console.WriteLine("Initial data matrix:");
            Console.WriteLine(matrix);

            // Specify a linear index.
            int linearIndex = 3;
            Console.WriteLine();
            Console.WriteLine("Linear index: {0}", linearIndex);

            // Set the corresponding entry.
            matrix[linearIndex] = new Complex(40, -40);

            Console.WriteLine();
            Console.WriteLine("Updated data matrix:");
            Console.WriteLine(matrix);

            // Entries can also be accessed using a read-only wrapper of the matrix.
            ReadOnlyComplexMatrix readOnlyMatrix = matrix.AsReadOnly();

            Console.WriteLine();
            Console.WriteLine("Updated matrix entry:");
            Console.WriteLine(readOnlyMatrix[linearIndex]);
        }
    }
}

// Executing method Main() produces the following output:
// 
// Initial data matrix:
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// (                4,               -4) (                8,               -8) 
// 
// 
// 
// Linear index: 3
// 
// Updated data matrix:
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// (               40,              -40) (                8,               -8) 
// 
// 
// 
// Updated matrix entry:
// <40; -40>

Exceptions

ArgumentOutOfRangeException

linearIndex is less than zero.
-or-
linearIndex is equal to or greater than the Count of this instance.