#include <vtkArrayExtents.h>
vtkArrayExtents describes the number of dimensions and coordinate ranges along each dimension of an N-way collection of values. It is used to retrieve and update the extents of a vtkArray object.
Conceptually, vtkArrayExtents is a collection of vtkArrayRange objects, one per dimension, that store the half-open range of valid coordinates (the "extent") for that dimension. Because each extent is stored as a range rather than a size, you can: create arrays that use one-based coordinates for consistency with mathematics and tools such as MATLAB; easily represent arbitrary subsets of an array; and easily store and manipulate distributed arrays using "global" coordinates.
Convenience constructors are provided for creating extents along one, two, and three dimensions. For higher dimensions, you can:
Use the static Uniform() factory method to create extents that have the same size along an arbitrary number of dimensions.
Use the default constructor and the Append() method to "grow" your extents to the correct number of dimensions.
Use the default constructuor, SetDimensions() and operator[] to assign a size along each dimension.
Definition at line 73 of file vtkArrayExtents.h.
| vtkArrayExtents::vtkArrayExtents | ( | ) |
Create zero-dimensional extents.
| vtkArrayExtents::vtkArrayExtents | ( | const vtkIdType | i | ) | [explicit] |
Create one-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i)).
| vtkArrayExtents::vtkArrayExtents | ( | const vtkArrayRange & | i | ) | [explicit] |
Create one-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i)).
Create two-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i), vtkArrayRange(0, j)).
| vtkArrayExtents::vtkArrayExtents | ( | const vtkArrayRange & | i, | |
| const vtkArrayRange & | j | |||
| ) |
Create two-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i), vtkArrayRange(0, j)).
Create three-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i), vtkArrayRange(0, j), vtkArrayRange(0, k)).
| vtkArrayExtents::vtkArrayExtents | ( | const vtkArrayRange & | i, | |
| const vtkArrayRange & | j, | |||
| const vtkArrayRange & | k | |||
| ) |
Create three-dimensional extents. This constructor is shorthand for vtkArrayExtents(vtkArrayRange(0, i), vtkArrayRange(0, j), vtkArrayRange(0, k)).
| static const vtkArrayExtents vtkArrayExtents::Uniform | ( | vtkIdType | n, | |
| vtkIdType | m | |||
| ) | [static] |
Create n-dimensional extents with extent [0, m) along each dimension. This is useful for creating e.g: a square matrix.
| void vtkArrayExtents::Append | ( | const vtkArrayRange & | extent | ) |
Grow the number of dimensions by one, specifying the extent of the new dimension.
| vtkIdType vtkArrayExtents::GetDimensions | ( | ) | const |
Return the current number of dimensions.
| vtkIdType vtkArrayExtents::GetSize | ( | ) | const |
Return the number of values that *could* be stored using the current extents. This is equal to the product of the size of the extent along each dimension.
| void vtkArrayExtents::SetDimensions | ( | vtkIdType | dimensions | ) |
Set the current number of dimensions. Note that this method resets the extent along each dimension to an empty range, so you must assign each dimension's extent explicitly using operator[] after calling SetDimensions().
| vtkArrayRange& vtkArrayExtents::operator[] | ( | vtkIdType | i | ) |
Accesses the extent of the i-th dimension.
| const vtkArrayRange& vtkArrayExtents::operator[] | ( | vtkIdType | i | ) | const |
Accesses the extent of the i-th dimension.
| bool vtkArrayExtents::operator== | ( | const vtkArrayExtents & | rhs | ) | const |
Equality comparison
| bool vtkArrayExtents::operator!= | ( | const vtkArrayExtents & | rhs | ) | const |
Inequality comparison
| bool vtkArrayExtents::ZeroBased | ( | ) | const |
Returns true iff every range in the current extents is zero-based. This is useful as a precondition test for legacy filters / operations that predate the switch to range-based extents and assume that all extents are zero-based. In general, new code should be written to work with arbitrary range extents, so won't need to perform this check.
| bool vtkArrayExtents::SameShape | ( | const vtkArrayExtents & | rhs | ) | const |
Returns true iff the given extents have the same number of dimensions and size along each dimension. Note that the ranges along each dimension may have different values, so long as their sizes match.
| void vtkArrayExtents::GetLeftToRightCoordinatesN | ( | vtkIdType | n, | |
| vtkArrayCoordinates & | coordinates | |||
| ) | const |
Returns coordinates that reference the n-th value in the extents, where n is in the range [0, GetSize()). The returned coordinates will be ordered so that the left-most indices vary fastest. The is equivalent to column-major ordering for matrices, and corresponds to the order in which consecutive array values would be stored in languages such as Fortran, MATLAB, Octave, and R.
| void vtkArrayExtents::GetRightToLeftCoordinatesN | ( | vtkIdType | n, | |
| vtkArrayCoordinates & | coordinates | |||
| ) | const |
Returns coordinates that reference the n-th value in the extents, where n is in the range [0, GetSize()). The returned coordinates will be ordered so that the left-most indices vary fastest. The is equivalent to column-major ordering for matrices, and corresponds to the order in which consecutive array values would be stored in languages such as Fortran, MATLAB, Octave, and R.
| bool vtkArrayExtents::Contains | ( | const vtkArrayExtents & | extents | ) | const |
Returns true if the given extents are a non-overlapping subset of the current extents. Returns false if any of the given extents fall outside the current extents, or there is a mismatch in the number of dimensions.
| bool vtkArrayExtents::Contains | ( | const vtkArrayCoordinates & | coordinates | ) | const |
Returns true if the given array coordinates are completely contained by the current extents (i.e. extent begin <= coordinate and coordinate < extent end along every dimension). Returns false if the array coordinates are outside the current extents, or contain a different number of dimensions.
| VTK_COMMON_EXPORT friend ostream& operator<< | ( | ostream & | stream, | |
| const vtkArrayExtents & | rhs | |||
| ) | [friend] |
1.5.6