VTK  9.1.20211028
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 
60 #ifndef vtkArrayExtents_h
61 #define vtkArrayExtents_h
62 
63 #include "vtkArrayRange.h"
64 #include "vtkCommonCoreModule.h" // For export macro
65 #include "vtkSystemIncludes.h"
66 #include <vector> // STL Header
67 
68 class VTKCOMMONCORE_EXPORT vtkArrayExtents
69 {
70 public:
73  typedef vtkTypeUInt64 SizeT;
74 
79 
84  explicit vtkArrayExtents(const CoordinateT i);
88  explicit vtkArrayExtents(const vtkArrayRange& i);
89 
99 
110 
116 
122 
127 
133  SizeT GetSize() const;
134 
141  void SetDimensions(DimensionT dimensions);
142 
147 
152 
157 
162 
166  bool operator==(const vtkArrayExtents& rhs) const;
167 
171  bool operator!=(const vtkArrayExtents& rhs) const;
172 
181  bool ZeroBased() const;
182 
189  bool SameShape(const vtkArrayExtents& rhs) const;
190 
200 
210 
217  bool Contains(const vtkArrayExtents& extents) const;
218 
226  bool Contains(const vtkArrayCoordinates& coordinates) const;
227 
228  VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArrayExtents& rhs);
229 
230 private:
231  std::vector<vtkArrayRange> Storage;
232 };
233 
234 #endif
235 // 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.
VTKCOMMONCORE_EXPORT friend ostream & operator<<(ostream &stream, const vtkArrayExtents &rhs)
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
const vtkArrayRange & operator[](DimensionT i) const
Accesses the extent of the i-th dimension.
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.
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,...
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.
Definition: vtkArrayRange.h:65
@ extent
Definition: vtkX3D.h:351