SheafSystem  0.0.0.0
i_adjacency_implicit_index_space_iterator.h
Go to the documentation of this file.
1 
2 //
3 // Copyright (c) 2014 Limit Point Systems, Inc.
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 
20 
21 #ifndef I_ADJACENCY_IMPLICIT_INDEX_SPACE_ITERATOR_H
22 #define I_ADJACENCY_IMPLICIT_INDEX_SPACE_ITERATOR_H
23 
24 #ifndef SHEAF_DLL_SPEC_H
25 #include "SheafSystem/sheaf_dll_spec.h"
26 #endif
27 
28 #ifndef AUTO_BLOCK_H
29 #include "SheafSystem/auto_block.h"
30 #endif
31 
32 #ifndef IMPLICIT_INDEX_SPACE_ITERATOR_H
33 #include "SheafSystem/implicit_index_space_iterator.h"
34 #endif
35 
36 namespace fiber_bundle
37 {
38 
39 using namespace sheaf;
40 
46 {
47 
48  friend class i_adjacency_implicit_index_space_interval;
49 
50  // ===========================================================
52  // ===========================================================
54 
55 public:
56 
61 
66 
71  pod_type xindex);
72 
77  const std::string& xname);
78 
83 
88 
92  pod_type hub_begin() const;
93 
97  size_type i_ct() const;
98 
99 protected:
100 
105 
110 
115 
116 private:
117 
119 
120 
121  // ===========================================================
123  // ===========================================================
125 
126 public:
127 
128 protected:
129 
130 private:
131 
133 
134 
135  // ===========================================================
137  // ===========================================================
138 
139 public:
140 
144  virtual i_adjacency_implicit_index_space_iterator& operator=(const index_space_iterator& xother);
145 
149  virtual bool operator==(const index_space_iterator& xother) const;
150 
155  virtual i_adjacency_implicit_index_space_iterator* clone() const;
156 
157 protected:
158 
159 private:
160 
162 
163 
164  // ===========================================================
166  // ===========================================================
168 
169 public:
170 
174  virtual void next();
175 
179  virtual void reset();
180 
181 protected:
182 
183 private:
184 
186 
187 
188  // ===========================================================
190  // ===========================================================
192 
193 public:
194 
196 
201  virtual void attach_to(const index_space_collection& xhost,
202  pod_type xlocal_id);
203 
205 
210  virtual bool conforms_to_state(const index_space_collection& xhost,
211  pod_type xlocal_id) const;
212 
213 protected:
214 
215 private:
216 
218 
219 
220  // ===========================================================
222  // ===========================================================
224 
225 public:
226 
230  virtual bool is_ancestor_of(const any *other) const;
231 
235  virtual bool invariant() const;
236 
237 protected:
238 
239 private:
240 
242 
243 };
244 
245 // ===========================================================
246 // NON-MEMBER FUNCTIONS
247 // ===========================================================
248 
249 
250 } // namespace fiber_bundle
251 
252 #endif // ifndef I_ADJACENCY_IMPLICIT_INDEX_SPACE_ITERATOR_H
An abstract iterator over the ids of an id space.
An implementation of implicit_index_space_iterator for an implicit id space in an i_adjacency_index_s...
pod_type _hub_begin
The hub id of the first zone in the adjacency list.
Abstract base class with useful features for all objects.
Definition: any.h:39
unsigned long size_type
An unsigned integral type used to represent sizes and capacities.
Definition: sheaf.h:52
An implementation of class index_space_iterator for id spaces that are implicitly represtented...
size_type _i_ct
The number of adjacent zones in the i direction.
virtual void attach_to(pod_type xindex)
Attach to the state with index xindex in the id space family id_spaces().
A collection of id space states. This is a virtual class with provides an interface for accessing the...
bool operator==(const singly_linked_list< T, Alloc > &lhs, const singly_linked_list< T, Alloc > &rhs)
Checks if the contents of lhs and rhs are equal, that is, whether lhs.size() == rhs.size() and each element in lhs compares equal with the element in rhs at the same position.
Namespace for the sheaves component of the sheaf system.
Factory and container for a family of id spaces.
pod_index_type pod_type
The "plain old data" index type for this.
Namespace for the fiber_bundles component of the sheaf system.
bool conforms_to_state(const index_space_family &xid_spaces, pod_type xindex) const
True if this conforms to the handle type required by the state with index xindex in the id space fami...