ComplexMatrixRowItem(Int32) Property

Gets or sets the entry of the ComplexMatrixRow having the specified column index.

Definition

Namespace: Novacta.Analytics
Assembly: Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.1.0+428f3840cfab98dda567bb0ed350b302533e273a
C#
public Complex this[
	int columnIndex
] { get; set; }

Parameters

columnIndex  Int32
 

Property Value

Complex
The row entry corresponding to the specified column index.

Remarks

A ComplexMatrixRow instance represents a row of a ComplexMatrix. More thoroughly, since each ComplexMatrixRow is an item in a ComplexMatrixRowCollection, such matrix can be inspected by getting the Matrix property of the given collection.

If setting, the ItemInt32 indexer fires the PropertyChanged event notifying that the name of the changed property is "[" + j + ]", where j is a string representation of columnIndex, and the new value becomes the entry of Matrix having row and column indexes given by Index and columnIndex, respectively.

If columnIndex equals any value returned by XDataColumn, YDataColumn, or ZDataColumn, then the PropertyChanged event is also fired to notify that properties XData, YData, or ZData have changed values, respectively.

Example

In the following example, all rows in a matrix are collected, and the indexer is applied to set specific row entries.

C#
using System;
using System.Numerics;

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

            // Get the collection of matrix rows.
            var rows = matrix.AsRowCollection();

            // Set a column index.
            var columnIndex = 1;

            // Set the row entries corresponding to the specified column index:
            // this code updates the data matrix, too.
            foreach (var row in rows)
            {
                row[columnIndex] = new Complex(row.Index * 100.0, 0);
            }

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

// Executing method Main() produces the following output:
// 
// Data matrix:
// (                1,               -1) (                5,               -5) 
// (                2,               -2) (                6,               -6) 
// (                3,               -3) (                7,               -7) 
// (                4,               -4) (                8,               -8) 
// 
// 
// 
// Updated data matrix:
// (                1,               -1) (                0,                0) 
// (                2,               -2) (              100,                0) 
// (                3,               -3) (              200,                0) 
// (                4,               -4) (              300,                0) 
// 
// 
//

Exceptions

ArgumentOutOfRangeExceptioncolumnIndex is not a valid column index for the matrix from which this row has been collected.

See Also