VTK  9.2.6
vtkArrayExtents.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkArrayExtents.h
5
6-------------------------------------------------------------------------
7 Copyright 2008 Sandia Corporation.
8 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 the U.S. Government retains certain rights in this software.
10-------------------------------------------------------------------------
11
12 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13 All rights reserved.
14 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15
16 This software is distributed WITHOUT ANY WARRANTY; without even
17 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18 PURPOSE. See the above copyright notice for more information.
19
20=========================================================================*/
21
63#ifndef vtkArrayExtents_h
64#define vtkArrayExtents_h
65
66#include "vtkArrayRange.h"
67#include "vtkCommonCoreModule.h" // For export macro
68#include "vtkSystemIncludes.h"
69#include <vector> // STL Header
70
71class VTKCOMMONCORE_EXPORT vtkArrayExtents
72{
73public:
76 typedef vtkTypeUInt64 SizeT;
77
82
87 explicit vtkArrayExtents(const CoordinateT i);
91 explicit vtkArrayExtents(const vtkArrayRange& i);
92
102
113
119
124 void Append(const vtkArrayRange& extent);
125
130
136 SizeT GetSize() const;
137
144 void SetDimensions(DimensionT dimensions);
145
150
155
160
165
169 bool operator==(const vtkArrayExtents& rhs) const;
170
174 bool operator!=(const vtkArrayExtents& rhs) const;
175
184 bool ZeroBased() const;
185
192 bool SameShape(const vtkArrayExtents& rhs) const;
193
203
213
220 bool Contains(const vtkArrayExtents& extents) const;
221
229 bool Contains(const vtkArrayCoordinates& coordinates) const;
230
231 VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArrayExtents& rhs);
232
233private:
234 std::vector<vtkArrayRange> Storage;
235};
236
237#endif
238// VTK-HeaderTest-Exclude: vtkArrayExtents.h
Stores coordinate into an N-way array.
Stores the number of dimensions and valid coordinate ranges along each dimension for vtkArray.
static vtkArrayExtents Uniform(DimensionT n, CoordinateT m)
Create n-dimensional extents with extent [0, m) along each dimension.
vtkTypeUInt64 SizeT
void SetExtent(DimensionT i, const vtkArrayRange &)
Set the extent of the i-th dimension.
vtkArrayCoordinates::CoordinateT CoordinateT
vtkArrayExtents(const vtkArrayRange &i, const vtkArrayRange &j, const vtkArrayRange &k)
Create three-dimensional extents.
vtkArrayExtents(const CoordinateT i)
Create zero-based one-dimensional extents.
vtkArrayRange GetExtent(DimensionT i) const
Get the extent of the i-th dimension.
SizeT GetSize() const
Return the number of values that could be stored using the current extents.
vtkArrayExtents(const CoordinateT i, const CoordinateT j)
Create zero-based two-dimensional extents.
void SetDimensions(DimensionT dimensions)
Set the current number of dimensions.
vtkArrayCoordinates::DimensionT DimensionT
vtkArrayExtents(const vtkArrayRange &i)
Create one-dimensional extents.
void Append(const vtkArrayRange &extent)
Grow the number of dimensions by one, specifying the extent of the new dimension.
vtkArrayExtents(const vtkArrayRange &i, const vtkArrayRange &j)
Create two-dimensional extents.
bool Contains(const vtkArrayCoordinates &coordinates) const
Returns true if the given array coordinates are completely contained by the current extents (i....
vtkArrayExtents()
Create zero-dimensional extents.
vtkArrayExtents(const CoordinateT i, const CoordinateT j, const CoordinateT k)
Create zero-based three-dimensional extents.
bool ZeroBased() const
Returns true iff every range in the current extents is zero-based.
bool operator==(const vtkArrayExtents &rhs) const
Equality comparison.
vtkArrayRange & operator[](DimensionT i)
Accesses the extent of the i-th dimension.
const vtkArrayRange & operator[](DimensionT i) const
Accesses the extent of the i-th dimension.
bool operator!=(const vtkArrayExtents &rhs) const
Inequality comparison.
void GetRightToLeftCoordinatesN(SizeT n, vtkArrayCoordinates &coordinates) const
Returns coordinates that reference the n-th value in the extents, where n is in the range [0,...
VTKCOMMONCORE_EXPORT friend ostream & operator<<(ostream &stream, const vtkArrayExtents &rhs)
bool Contains(const vtkArrayExtents &extents) const
Returns true if the given extents are a non-overlapping subset of the current extents.
DimensionT GetDimensions() const
Return the current number of dimensions.
void GetLeftToRightCoordinatesN(SizeT n, vtkArrayCoordinates &coordinates) const
Returns coordinates that reference the n-th value in the extents, where n is in the range [0,...
bool SameShape(const vtkArrayExtents &rhs) const
Returns true iff the given extents have the same number of dimensions and size along each dimension.
Stores a half-open range of array coordinates.