| 1 |
// ------------------------------------------------------------------------ |
| 2 |
// |
| 3 |
// SPDX-License-Identifier: LGPL-2.1-or-later |
| 4 |
// Copyright (C) 1999 - 2018 by the deal.II authors |
| 5 |
// |
| 6 |
// This file is part of the deal.II library. |
| 7 |
// |
| 8 |
// Part of the source code is dual licensed under Apache-2.0 WITH |
| 9 |
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information |
| 10 |
// governing the source code and code contributions can be found in |
| 11 |
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II. |
| 12 |
// |
| 13 |
// ------------------------------------------------------------------------ |
| 14 |
|
| 15 |
#ifndef dealii_tria_iterator_base_h |
| 16 |
#define dealii_tria_iterator_base_h |
| 17 |
|
| 18 |
|
| 19 |
#include <deal.II/base/config.h> |
| 20 |
|
| 21 |
DEAL_II_NAMESPACE_OPEN |
| 22 |
|
| 23 |
/** |
| 24 |
* Namespace in which an enumeration is declared that denotes the states in |
| 25 |
* which an iterator can be in. |
| 26 |
* |
| 27 |
* @ingroup Iterators |
| 28 |
*/ |
| 29 |
namespace IteratorState |
| 30 |
{ |
| 31 |
/** |
| 32 |
* The three states an iterator can be in: valid, past-the-end and invalid. |
| 33 |
*/ |
| 34 |
enum IteratorStates |
| 35 |
{ |
| 36 |
/// Iterator points to a valid object |
| 37 |
valid, |
| 38 |
/// Iterator reached end of container |
| 39 |
past_the_end, |
| 40 |
/// Iterator is invalid, probably due to an error |
| 41 |
invalid |
| 42 |
}; |
| 43 |
} // namespace IteratorState |
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
DEAL_II_NAMESPACE_CLOSE |
| 48 |
|
| 49 |
#endif |