ComplexMatrixItem(String, Int32) Property

Gets or sets the elements of this instance corresponding to the specified row and column indexes.

Definition

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

C#

public ComplexMatrix this[
	string rowIndexes,
	int columnIndex
] { get; set; }

VB

Public Default Property Item ( 
	rowIndexes As String,
	columnIndex As Integer
) As ComplexMatrix
	Get
	Set

C++

public:
virtual property ComplexMatrix^ default[String^ rowIndexes, int columnIndex] {
	ComplexMatrix^ get (String^ rowIndexes, int columnIndex) sealed;
	void set (String^ rowIndexes, int columnIndex, ComplexMatrix^ value) sealed;
}

F#

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

Parameters

rowIndexes String: The zero-based row indexes of the elements to get or set. The value must be ":", which means that all valid row indexes are specified.
columnIndex Int32: The zero-based column index of the elements to get or set.

Property Value

ComplexMatrix
A tabular collection formed by the entries corresponding to the specified row and column indexes.

Implements

IReadOnlyTabularCollectionTValue, TCollectionItemString, Int32
ITabularCollectionTValue, TCollectionItemString, Int32

Remarks

When setting elements simultaneously, the value must be a tabular collection having a number of rows equal to the number of specified row indexes, and a number of columns equal to the number of specified column indexes.

Example

In the following example, some matrix elements are simultaneously accessed.

C#

using System;
using System.Numerics;

namespace Novacta.Analytics.CodeExamples
{
    public class ComplexMatrixIndexerExample20  
    {
        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 all row indexes.
            var rowIndexes = ":";
            Console.WriteLine();
            Console.WriteLine("Row indexes: from 0 to {0}", matrix.NumberOfRows - 1);

            // Specify a column index.
            int columnIndex = 0;
            Console.WriteLine();
            Console.WriteLine("Column index: {0}", columnIndex);

            // Specify the value matrix.
            var valueData = new Complex[4] {
                new(10, -10),
                new(20, -20),
                new(30, -30),
                new(40, -40)
            };
            var value = ComplexMatrix.Dense(4, 1, valueData, StorageOrder.RowMajor);
            Console.WriteLine();
            Console.WriteLine("Value matrix:");
            Console.WriteLine(value);

            // Set the entries having the specified indexes to the value matrix.
            matrix[rowIndexes, columnIndex] = value;

            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 entries:");
            Console.WriteLine(readOnlyMatrix[rowIndexes, columnIndex]);
        }
    }
}

// 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) 
// 
// 
// 
// Row indexes: from 0 to 3
// 
// Column index: 0
// 
// Value matrix:
// (               10,              -10) 
// (               20,              -20) 
// (               30,              -30) 
// (               40,              -40) 
// 
// 
// 
// Updated data matrix:
// (               10,              -10) (                5,               -5) 
// (               20,              -20) (                6,               -6) 
// (               30,              -30) (                7,               -7) 
// (               40,              -40) (                8,               -8) 
// 
// 
// 
// Updated matrix entries:
// (               10,              -10) 
// (               20,              -20) 
// (               30,              -30) 
// (               40,              -40) 
// 
//

Exceptions

ArgumentNullException	rowIndexes is null. -or- value is null.
ArgumentOutOfRangeException	rowIndexes is not a string reserved for collection sub-referencing. -or- columnIndex is less than zero. -or- columnIndex is greater than or equal to the number of columns of this instance.
ArgumentException	The number of rows in value is not equal to the to the number of rows of this instance. -or- The number of columns in value is greater than 1.