VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSparseArray< T > Class Template Reference

Sparse, independent coordinate storage for N-way arrays. More...

#include <vtkSparseArray.h>

Inheritance diagram for vtkSparseArray< T >:
[legend]
Collaboration diagram for vtkSparseArray< T >:
[legend]

Public Types

typedef vtkArray::CoordinateT CoordinateT
 
typedef vtkArray::DimensionT DimensionT
 
typedef vtkArray::SizeT SizeT
 
- Public Types inherited from vtkTypedArray< T >
typedef vtkArray::CoordinateT CoordinateT
 
typedef vtkArray::SizeT SizeT
 
- Public Types inherited from vtkArray
enum  { DENSE = 0, SPARSE = 1 }
 
typedef vtkObject Superclass
 
typedef vtkArrayExtents::CoordinateT CoordinateT
 
typedef vtkArrayExtents::DimensionT DimensionT
 
typedef vtkArrayExtents::SizeT SizeT
 

Public Member Functions

 vtkTemplateTypeMacro (vtkSparseArray< T >, vtkTypedArray< T >)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool IsDense () override
 Returns true iff the underlying array storage is "dense", i.e. More...
 
const vtkArrayExtentsGetExtents () override
 Returns the extents (the number of dimensions and size along each dimension) of the array. More...
 
SizeT GetNonNullSize () override
 Returns the number of non-null values stored in the array. More...
 
void GetCoordinatesN (const SizeT n, vtkArrayCoordinates &coordinates) override
 Returns the coordinates of the n-th value in the array, where n is in the range [0, GetNonNullSize()). More...
 
vtkArrayDeepCopy () override
 Returns a new array that is a deep copy of this array. More...
 
const T & GetValue (CoordinateT i) override
 Returns the value stored in the array at the given coordinates. More...
 
const T & GetValue (CoordinateT i, CoordinateT j) override
 
const T & GetValue (CoordinateT i, CoordinateT j, CoordinateT k) override
 
const T & GetValue (const vtkArrayCoordinates &coordinates) override
 
const T & GetValueN (const SizeT n) override
 Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More...
 
void SetValue (CoordinateT i, const T &value) override
 Overwrites the value stored in the array at the given coordinates. More...
 
void SetValue (CoordinateT i, CoordinateT j, const T &value) override
 
void SetValue (CoordinateT i, CoordinateT j, CoordinateT k, const T &value) override
 
void SetValue (const vtkArrayCoordinates &coordinates, const T &value) override
 
void SetValueN (const SizeT n, const T &value) override
 Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More...
 
void SetNullValue (const T &value)
 Set the value that will be returned by GetValue() for nullptr areas of the array. More...
 
const T & GetNullValue ()
 Returns the value that will be returned by GetValue() for nullptr areas of the array. More...
 
void Clear ()
 Remove all non-null elements from the array, leaving the number of dimensions, the extent of each dimension, and the label for each dimension unchanged. More...
 
void Sort (const vtkArraySort &sort)
 Sorts array values so that their coordinates appear in some well-defined order. More...
 
std::vector< CoordinateTGetUniqueCoordinates (DimensionT dimension)
 Returns the set of unique coordinates along the given dimension. More...
 
const CoordinateTGetCoordinateStorage (DimensionT dimension) const
 Return a read-only reference to the underlying coordinate storage. More...
 
CoordinateTGetCoordinateStorage (DimensionT dimension)
 Return a mutable reference to the underlying coordinate storage. More...
 
const T * GetValueStorage () const
 Return a read-only reference to the underlying value storage. More...
 
T * GetValueStorage ()
 Return a mutable reference to the underlying value storage. More...
 
void ReserveStorage (const SizeT value_count)
 Reserve storage for a specific number of values. More...
 
void SetExtentsFromContents ()
 Update the array extents to match its contents, so that the extent along each dimension matches the maximum index value along that dimension. More...
 
void SetExtents (const vtkArrayExtents &extents)
 Specify arbitrary array extents, without altering the contents of the array. More...
 
void AddValue (CoordinateT i, const T &value)
 Adds a new non-null element to the array. More...
 
void AddValue (CoordinateT i, CoordinateT j, const T &value)
 
void AddValue (CoordinateT i, CoordinateT j, CoordinateT k, const T &value)
 
void AddValue (const vtkArrayCoordinates &coordinates, const T &value)
 
bool Validate ()
 Validate the contents of the array, returning false if there are any problems. More...
 
- Public Member Functions inherited from vtkTypedArray< T >
 vtkTemplateTypeMacro (vtkTypedArray< T >, vtkArray)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkVariant GetVariantValue (const vtkArrayCoordinates &coordinates) override
 
vtkVariant GetVariantValueN (const SizeT n) override
 Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More...
 
void SetVariantValue (const vtkArrayCoordinates &coordinates, const vtkVariant &value) override
 
void SetVariantValueN (const SizeT n, const vtkVariant &value) override
 Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()). More...
 
void CopyValue (vtkArray *source, const vtkArrayCoordinates &source_coordinates, const vtkArrayCoordinates &target_coordinates) override
 Overwrites a value with a value retrieved from another array. More...
 
void CopyValue (vtkArray *source, const SizeT source_index, const vtkArrayCoordinates &target_coordinates) override
 
void CopyValue (vtkArray *source, const vtkArrayCoordinates &source_coordinates, const SizeT target_index) override
 
vtkVariant GetVariantValue (CoordinateT i)
 Returns the value stored in the array at the given coordinates. More...
 
vtkVariant GetVariantValue (CoordinateT i, CoordinateT j)
 
vtkVariant GetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k)
 
virtual vtkVariant GetVariantValue (const vtkArrayCoordinates &coordinates)=0
 
void SetVariantValue (CoordinateT i, const vtkVariant &value)
 Overwrites the value stored in the array at the given coordinates. More...
 
void SetVariantValue (CoordinateT i, CoordinateT j, const vtkVariant &value)
 
void SetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant &value)
 
virtual void SetVariantValue (const vtkArrayCoordinates &coordinates, const vtkVariant &value)=0
 
- Public Member Functions inherited from vtkArray
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkArrayNewInstance () const
 
void Resize (const CoordinateT i)
 Resizes the array to the given extents (number of dimensions and size of each dimension). More...
 
void Resize (const CoordinateT i, const CoordinateT j)
 
void Resize (const CoordinateT i, const CoordinateT j, const CoordinateT k)
 
void Resize (const vtkArrayRange &i)
 
void Resize (const vtkArrayRange &i, const vtkArrayRange &j)
 
void Resize (const vtkArrayRange &i, const vtkArrayRange &j, const vtkArrayRange &k)
 
void Resize (const vtkArrayExtents &extents)
 
vtkArrayRange GetExtent (DimensionT dimension)
 Returns the extent (valid coordinate range) along the given dimension. More...
 
DimensionT GetDimensions ()
 Returns the number of dimensions stored in the array. More...
 
SizeT GetSize ()
 Returns the number of values stored in the array. More...
 
void SetName (const vtkStdString &name)
 Sets the array name. More...
 
vtkStdString GetName ()
 Returns the array name. More...
 
void SetDimensionLabel (DimensionT i, const vtkStdString &label)
 Sets the label for the i-th array dimension. More...
 
vtkStdString GetDimensionLabel (DimensionT i)
 Returns the label for the i-th array dimension. More...
 
vtkVariant GetVariantValue (CoordinateT i)
 Returns the value stored in the array at the given coordinates. More...
 
vtkVariant GetVariantValue (CoordinateT i, CoordinateT j)
 
vtkVariant GetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k)
 
void SetVariantValue (CoordinateT i, const vtkVariant &value)
 Overwrites the value stored in the array at the given coordinates. More...
 
void SetVariantValue (CoordinateT i, CoordinateT j, const vtkVariant &value)
 
void SetVariantValue (CoordinateT i, CoordinateT j, CoordinateT k, const vtkVariant &value)
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkSparseArray< T > * New ()
 
- Static Public Member Functions inherited from vtkArray
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkArraySafeDownCast (vtkObjectBase *o)
 
static vtkArrayCreateArray (int StorageType, int ValueType)
 Creates a new array where StorageType is one of vtkArray::DENSE or vtkArray::SPARSE, and ValueType is one of VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_ID_TYPE, or VTK_STRING. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkSparseArray ()
 
 ~vtkSparseArray () override
 
- Protected Member Functions inherited from vtkTypedArray< T >
 vtkTypedArray ()
 
 ~vtkTypedArray () override
 
- Protected Member Functions inherited from vtkArray
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkArray ()
 
 ~vtkArray () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

template<typename T>
class vtkSparseArray< T >

Sparse, independent coordinate storage for N-way arrays.

vtkSparseArray is a concrete vtkArray implementation that stores values using sparse independent coordinate storage. This means that the array stores the complete set of coordinates and the value for each non-null value in the array. While this approach requires slightly more storage than other sparse storage schemes (such as Compressed-Row or Compressed-Column), it is easier and more efficient to work with when implementing algorithms, and it generalizes well for arbitrary numbers of dimensions.

In addition to the value retrieval and update methods provided by vtkTypedArray, vtkSparseArray provides methods to:

Get and set a special 'null' value that will be returned when retrieving values for undefined coordinates.

Clear the contents of the array so that every set of coordinates is undefined.

Sort the array contents so that value coordinates can be visited in a specific order.

Retrieve pointers to the value- and coordinate-storage memory blocks.

Reserve storage for a specific number of non-null values, for efficiency when the number of non-null values is known in advance.

Recompute the array extents so that they bound the largest set of non-nullptr values along each dimension.

Specify arbitrary array extents.

Add values to the array in amortized-constant time.

Validate that the array does not contain duplicate coordinates.

See also
vtkArray, vtkTypedArray, vtkDenseArray
Thanks:
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.

Definition at line 75 of file vtkSparseArray.h.

Member Typedef Documentation

◆ CoordinateT

template<typename T>
typedef vtkArray::CoordinateT vtkSparseArray< T >::CoordinateT

Definition at line 82 of file vtkSparseArray.h.

◆ DimensionT

template<typename T>
typedef vtkArray::DimensionT vtkSparseArray< T >::DimensionT

Definition at line 83 of file vtkSparseArray.h.

◆ SizeT

template<typename T>
typedef vtkArray::SizeT vtkSparseArray< T >::SizeT

Definition at line 84 of file vtkSparseArray.h.

Constructor & Destructor Documentation

◆ vtkSparseArray()

template<typename T>
vtkSparseArray< T >::vtkSparseArray ( )
protected

◆ ~vtkSparseArray()

template<typename T>
vtkSparseArray< T >::~vtkSparseArray ( )
overrideprotected

Member Function Documentation

◆ vtkTemplateTypeMacro()

template<typename T>
vtkSparseArray< T >::vtkTemplateTypeMacro ( vtkSparseArray< T >  ,
vtkTypedArray< T >   
)

◆ New()

template<typename T>
static vtkSparseArray<T>* vtkSparseArray< T >::New ( )
static

◆ PrintSelf()

template<typename T>
void vtkSparseArray< T >::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkArray.

◆ IsDense()

template<typename T>
bool vtkSparseArray< T >::IsDense ( )
overridevirtual

Returns true iff the underlying array storage is "dense", i.e.

that GetSize() and GetNonNullSize() will always return the same value. If not, the array is "sparse".

Implements vtkArray.

◆ GetExtents()

template<typename T>
const vtkArrayExtents& vtkSparseArray< T >::GetExtents ( )
overridevirtual

Returns the extents (the number of dimensions and size along each dimension) of the array.

Implements vtkArray.

◆ GetNonNullSize()

template<typename T>
SizeT vtkSparseArray< T >::GetNonNullSize ( )
overridevirtual

Returns the number of non-null values stored in the array.

Note that this value will equal GetSize() for dense arrays, and will be less-than-or-equal to GetSize() for sparse arrays.

Implements vtkArray.

◆ GetCoordinatesN()

template<typename T>
void vtkSparseArray< T >::GetCoordinatesN ( const SizeT  n,
vtkArrayCoordinates coordinates 
)
overridevirtual

Returns the coordinates of the n-th value in the array, where n is in the range [0, GetNonNullSize()).

Note that the order in which coordinates are visited is undefined, but is guaranteed to match the order in which values are visited using vtkTypedArray::GetValueN() and vtkTypedArray::SetValueN().

Implements vtkArray.

◆ DeepCopy()

template<typename T>
vtkArray* vtkSparseArray< T >::DeepCopy ( )
overridevirtual

Returns a new array that is a deep copy of this array.

Implements vtkArray.

◆ GetValue() [1/4]

template<typename T>
const T& vtkSparseArray< T >::GetValue ( CoordinateT  i)
overridevirtual

Returns the value stored in the array at the given coordinates.

Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.

Implements vtkTypedArray< T >.

◆ GetValue() [2/4]

template<typename T>
const T& vtkSparseArray< T >::GetValue ( CoordinateT  i,
CoordinateT  j 
)
overridevirtual

Implements vtkTypedArray< T >.

◆ GetValue() [3/4]

template<typename T>
const T& vtkSparseArray< T >::GetValue ( CoordinateT  i,
CoordinateT  j,
CoordinateT  k 
)
overridevirtual

Implements vtkTypedArray< T >.

◆ GetValue() [4/4]

template<typename T>
const T& vtkSparseArray< T >::GetValue ( const vtkArrayCoordinates coordinates)
overridevirtual

Implements vtkTypedArray< T >.

◆ GetValueN()

template<typename T>
const T& vtkSparseArray< T >::GetValueN ( const SizeT  n)
overridevirtual

Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).

This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().

Implements vtkTypedArray< T >.

◆ SetValue() [1/4]

template<typename T>
void vtkSparseArray< T >::SetValue ( CoordinateT  i,
const T &  value 
)
overridevirtual

Overwrites the value stored in the array at the given coordinates.

Note that the number of dimensions in the supplied coordinates must match the number of dimensions in the array.

Implements vtkTypedArray< T >.

◆ SetValue() [2/4]

template<typename T>
void vtkSparseArray< T >::SetValue ( CoordinateT  i,
CoordinateT  j,
const T &  value 
)
overridevirtual

Implements vtkTypedArray< T >.

◆ SetValue() [3/4]

template<typename T>
void vtkSparseArray< T >::SetValue ( CoordinateT  i,
CoordinateT  j,
CoordinateT  k,
const T &  value 
)
overridevirtual

Implements vtkTypedArray< T >.

◆ SetValue() [4/4]

template<typename T>
void vtkSparseArray< T >::SetValue ( const vtkArrayCoordinates coordinates,
const T &  value 
)
overridevirtual

Implements vtkTypedArray< T >.

◆ SetValueN()

template<typename T>
void vtkSparseArray< T >::SetValueN ( const SizeT  n,
const T &  value 
)
overridevirtual

Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).

This is useful for efficiently visiting every value in the array. Note that the order in which values are visited is undefined, but is guaranteed to match the order used by vtkArray::GetCoordinatesN().

Implements vtkTypedArray< T >.

◆ SetNullValue()

template<typename T>
void vtkSparseArray< T >::SetNullValue ( const T &  value)

Set the value that will be returned by GetValue() for nullptr areas of the array.

◆ GetNullValue()

template<typename T>
const T& vtkSparseArray< T >::GetNullValue ( )

Returns the value that will be returned by GetValue() for nullptr areas of the array.

◆ Clear()

template<typename T>
void vtkSparseArray< T >::Clear ( )

Remove all non-null elements from the array, leaving the number of dimensions, the extent of each dimension, and the label for each dimension unchanged.

◆ Sort()

template<typename T>
void vtkSparseArray< T >::Sort ( const vtkArraySort sort)

Sorts array values so that their coordinates appear in some well-defined order.

The supplied vtkArraySort object controls which dimensions are sorted, and in what order, and should contain one-or-more sort dimensions, up to the number of dimensions stored in the array.

◆ GetUniqueCoordinates()

template<typename T>
std::vector<CoordinateT> vtkSparseArray< T >::GetUniqueCoordinates ( DimensionT  dimension)

Returns the set of unique coordinates along the given dimension.

◆ GetCoordinateStorage() [1/2]

template<typename T>
const CoordinateT* vtkSparseArray< T >::GetCoordinateStorage ( DimensionT  dimension) const

Return a read-only reference to the underlying coordinate storage.

Coordinates for each dimension are stored contiguously as a one-dimensional array. The ordering of coordinates within the array depends on the order in which values were added to the array.

◆ GetCoordinateStorage() [2/2]

template<typename T>
CoordinateT* vtkSparseArray< T >::GetCoordinateStorage ( DimensionT  dimension)

Return a mutable reference to the underlying coordinate storage.

Coordinates for each dimension are stored contiguously as a one-dimensional array. The ordering of coordinates within the array depends on the order in which values were added to the array, and any subsequent sorting. Use at your own risk!

◆ GetValueStorage() [1/2]

template<typename T>
const T* vtkSparseArray< T >::GetValueStorage ( ) const

Return a read-only reference to the underlying value storage.

Values are stored contiguously, but in arbitrary order. Use GetCoordinateStorage() if you need to get the corresponding coordinates for a value.

◆ GetValueStorage() [2/2]

template<typename T>
T* vtkSparseArray< T >::GetValueStorage ( )

Return a mutable reference to the underlying value storage.

Values are stored contiguously, but in arbitrary order. Use GetCoordinateStorage() if you need to get the corresponding coordinates for a value. Use at your own risk!

◆ ReserveStorage()

template<typename T>
void vtkSparseArray< T >::ReserveStorage ( const SizeT  value_count)

Reserve storage for a specific number of values.

This is useful for reading external data using GetCoordinateStorage() and GetValueStorage(), when the total number of non-nullptr values in the array can be determined in advance. Note that after calling ReserveStorage(), all coordinates and values will be undefined, so you must ensure that every set of coordinates and values is overwritten. It is the caller's responsibility to ensure that duplicate coordinates are not inserted into the array.

◆ SetExtentsFromContents()

template<typename T>
void vtkSparseArray< T >::SetExtentsFromContents ( )

Update the array extents to match its contents, so that the extent along each dimension matches the maximum index value along that dimension.

◆ SetExtents()

template<typename T>
void vtkSparseArray< T >::SetExtents ( const vtkArrayExtents extents)

Specify arbitrary array extents, without altering the contents of the array.

Note that the extents must be as-large-or-larger-than the extents of the actual values stored in the array. The number of dimensions in the supplied extents must match the number of dimensions currently stored in the array.

◆ AddValue() [1/4]

template<typename T>
void vtkSparseArray< T >::AddValue ( CoordinateT  i,
const T &  value 
)
inline

Adds a new non-null element to the array.

Does not test to see if an element with matching coordinates already exists. Useful for providing fast initialization of the array as long as the caller is prepared to guarantee that no duplicate coordinates are ever used.

◆ AddValue() [2/4]

template<typename T>
void vtkSparseArray< T >::AddValue ( CoordinateT  i,
CoordinateT  j,
const T &  value 
)
inline

◆ AddValue() [3/4]

template<typename T>
void vtkSparseArray< T >::AddValue ( CoordinateT  i,
CoordinateT  j,
CoordinateT  k,
const T &  value 
)
inline

◆ AddValue() [4/4]

template<typename T>
void vtkSparseArray< T >::AddValue ( const vtkArrayCoordinates coordinates,
const T &  value 
)

◆ Validate()

template<typename T>
bool vtkSparseArray< T >::Validate ( )

Validate the contents of the array, returning false if there are any problems.

Potential problems include duplicate coordinates, which can be introduced into the array either through AddValue() or direct access to coordinates storage; and coordinates out-of-bounds given the current array extents.

Note that Validate() is a heavyweight O(N log N) operation that is intended for temporary use during debugging.


The documentation for this class was generated from the following file: