DimSpec Class

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Class representing a one-dimensional slice / range or single index along a dimension. Used for subarray indexing.

[ILNumerics Core Module]

Inheritance Hierarchy

SystemObject
  ILNumericsBaseArray
    ILNumericsDimSpec
      ILNumericsEllipsisSpec
      ILNumericsExpressionDimSpec
      ILNumericsFullDimSpec
      ILNumericsNewaxisSpec

Namespace: ILNumerics
Assembly: ILNumerics.Core (in ILNumerics.Core.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

Copy

[SerializableAttribute]
public class DimSpec : BaseArray, IDisposable, 
	IIndexIterator, IEnumerable<long>, IEnumerable, IEnumerator<long>, 
	IEnumerator, IStorage

<SerializableAttribute>
Public Class DimSpec
	Inherits BaseArray
	Implements IDisposable, IIndexIterator, IEnumerable(Of Long), 
	IEnumerable, IEnumerator(Of Long), IEnumerator, IStorage

Dim instance As DimSpec

The DimSpec type exposes the following members.

Constructors

	Name	Description
	DimSpec	Initializes a new instance of the DimSpec class

Top

Properties

	Name	Description
	Current
	End
	IsColumnVector	(Overrides BaseArrayIsColumnVector.)
	IsComplex	(Overrides BaseArrayIsComplex.)
	IsDisposed	(Overrides BaseArrayIsDisposed.)
	IsEmpty	(Overrides BaseArrayIsEmpty.)
	IsMatrix	(Overrides BaseArrayIsMatrix.)
	IsNumeric	(Overrides BaseArrayIsNumeric.)
	IsRowVector	(Overrides BaseArrayIsRowVector.)
	IsScalar	(Overrides BaseArrayIsScalar.)
	IsSingleIndex
	IsSlice
	IsVector	(Overrides BaseArrayIsVector.)
	Length	Number of elements referenced by this dimension specifier. [ILNumerics Core Module] (Overrides BaseArrayLength.)
	ReferenceCount	(Overrides BaseArrayReferenceCount.)
	S	(Overrides BaseArrayS.)
	Size	(Overrides BaseArraySize.)
	Start
	Step

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the DimSpec
	Equals	(Overrides BaseArrayEquals(Object).)
	GetElementType	(Overrides BaseArrayGetElementType.)
	GetEnumerator	Gives an IEnumeratorT capable of iterating over the index range specified by this object. [ILNumerics Core Module]
	GetItem	(Overrides BaseArrayGetItem(Int64).)
	GetLastDimensionIndex
	GetLength
	GetMaximum
	GetMinimum
	GetStepSize	Gives the stepsize configured for this dimension specifier. [ILNumerics Core Module]
	IsOfTypeT	(Overrides BaseArrayIsOfTypeElementType.)
	MoveNext	Increments the internal position counter to the next index. [ILNumerics Core Module]
	Reset	Places the internal position counter back before the first element. [ILNumerics Core Module]
	ShortInfo	(Overrides BaseArrayShortInfo.)
	ShortInfo(Boolean, Boolean, Boolean, Boolean)	(Overrides BaseArrayShortInfo(Boolean, Boolean, Boolean, Boolean).)
	ToStream	(Overrides BaseArrayToStream(Stream, String, ArrayStreamSerializationFlags).)
	ToString	(Overrides ObjectToString.)
	ToString(UInt32, UInt32, NullableStorageOrders, Boolean, Boolean, NullableInt32)	Creates a textual representation of a derived array and allows to control display parameters. [ILNumerics Core Module] (Inherited from BaseArray.)
	ToXML	(Overrides BaseArrayToXML(XmlWriter).)

Top

Operators

	Name	Description
	(Int64 to DimSpec)	Implicit cast from single index to dimension specifier. [ILNumerics Core Module]
	(UInt32 to DimSpec)	Implicit cast from single index to dimension specifier. [ILNumerics Core Module]
	(ILExpression to DimSpec)

Top

Fields

	Name	Description
	m_cur
	m_end
	m_isSingleIndex
	m_isSlice
	m_last
	m_lastElementIDX
	m_start
	m_step

Top

Remarks

[ILNumerics Core Module]

Reference

ILNumerics Namespace