Click or drag to resize

IndexValuePair Structure

Defines an index/value pair.

Namespace:  Novacta.Analytics
Assembly:  Novacta.Analytics (in Novacta.Analytics.dll) Version: 2.0.0
Syntax
public struct IndexValuePair : IEquatable<IndexValuePair>

The IndexValuePair type exposes the following members.

Properties
  NameDescription
Public propertyIndex
Gets the index in the index/value pair.
Public propertyValue
Gets the value in the index/value pair.
Top
Methods
  NameDescription
Public methodEquals(IndexValuePair)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(Object)
Indicates whether this instance and a specified object are equal.
(Overrides ValueTypeEquals(Object).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Returns the hash code for this instance.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns the fully qualified type name of this instance.
(Inherited from ValueType.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Returns a value that indicates whether an IndexValuePair instance is equal to another IndexValuePair instance.
Public operatorStatic memberInequality
Returns a value that indicates whether an IndexValuePair instance is not equal to another IndexValuePair instance.
Top
Remarks

An IndexValuePair structure groups a zero based index to a value. This is useful if the position of a particular value inside a given matrix has to be returned.

For example, method Max(DoubleMatrix) uses an IndexValuePair to return the maximum value and its (say, first) linear position in the specified data matrix, where matrix entries are interpreted as linearly ordered following a column major ordering.

See Also