DoubleMatrixItem(IndexCollection, IndexCollection, Boolean) Property

Note: This API is now obsolete.

Gets 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#

[ObsoleteAttribute("Use instead indexers having no parameter 'avoidDenseAllocations'.")]
public DoubleMatrix this[
	IndexCollection rowIndexes,
	IndexCollection columnIndexes,
	bool avoidDenseAllocations
] { get; }

VB

<ObsoleteAttribute("Use instead indexers having no parameter 'avoidDenseAllocations'.")>
Public ReadOnly Default Property Item ( 
	rowIndexes As IndexCollection,
	columnIndexes As IndexCollection,
	avoidDenseAllocations As Boolean
) As DoubleMatrix
	Get

C++

public:
[ObsoleteAttribute(L"Use instead indexers having no parameter 'avoidDenseAllocations'.")]
property DoubleMatrix^ default[IndexCollection^ rowIndexes, IndexCollection^ columnIndexes, bool avoidDenseAllocations] {
	DoubleMatrix^ get (IndexCollection^ rowIndexes, IndexCollection^ columnIndexes, bool avoidDenseAllocations);
}

F#

[<ObsoleteAttribute("Use instead indexers having no parameter 'avoidDenseAllocations'.")>]
member Item : DoubleMatrix with get

Parameters

rowIndexes IndexCollection: The zero-based row indexes of the elements to get.
columnIndexes IndexCollection: The zero-based column indexes of the elements to get.
avoidDenseAllocations Boolean: If set to true signals that the elements to get will not be stored in the returned matrix applying the Dense storage scheme. Always ignored in the current release.

Property Value

DoubleMatrix
A tabular collection formed by the elements corresponding to the specified row and column indexes.

Remarks

Caution

In previous releases, this indexer returned matrices whose entries were, in some cases, not directly stored: if parameter avoidDenseAllocations was true then the indexer tried to minimize memory allocations by avoiding the application of the Dense storage scheme.

Indexers that try to avoid dense allocations have been deprecated and their use is not recommended.

In the current release, the value passed to parameter avoidDenseAllocations is ignored.

In future releases, this indexer will be removed from the public API. Please use instead indexer ItemIndexCollection, IndexCollection.

Exceptions

ArgumentNullException	rowIndexes is null. -or- columnIndexes is null.
ArgumentOutOfRangeException	rowIndexes contains an index which is greater than or equal to the number of rows of this instance. -or- columnIndexes contains an index which is greater than or equal to the number of columns of this instance.