mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
165 lines
2.9 KiB
Markdown
165 lines
2.9 KiB
Markdown
---
|
|
title: "cyclic_value"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `cyclic_value.h`
|
|
Since: `TBC`
|
|
{{< /callout >}}
|
|
|
|
Provides a value that cycles between two limits.
|
|
Supports increments, decrements and arbitrary advance.
|
|
Supports compile time and runtime variants.
|
|
|
|
```cpp
|
|
template <typename T, const T First = 0, const T Last = 0>
|
|
class cyclic_value
|
|
```
|
|
|
|
```cpp
|
|
etl::cyclic_value<int, 2, 7> value_ct; // Compile time. Fixed range of 2 to 7 inclusive.
|
|
|
|
etl::cyclic_value<int> value_rt(2, 7); // Run time. Modifiable range.
|
|
value_rt.set(3, 8);
|
|
```
|
|
|
|
## Constructor
|
|
```cpp
|
|
cyclic_value<int> value;
|
|
```
|
|
Creates a runtime cyclic value of type int with default constructed initial defined limits.
|
|
|
|
---
|
|
|
|
```cpp
|
|
cyclic_value<int, N, M> value;
|
|
```
|
|
Creates a compile time cyclic value of type int with fixed limits of N and M.
|
|
|
|
**Example**
|
|
```cpp
|
|
cyclic_value<int> value(N, M);
|
|
```
|
|
Creates a runtime cyclic value of type int with initial defined limits of N and M.
|
|
|
|
## Modifiers
|
|
```cpp
|
|
cyclic_value& operator ++();
|
|
cyclic_value& operator ++(int);
|
|
```
|
|
Increments the value. If the value is at the last value then is set to the first.
|
|
|
|
---
|
|
|
|
```cpp
|
|
cyclic_value& operator --();
|
|
cyclic_value& operator --(int);
|
|
```
|
|
Decrements the value. If the value is at the first value then is set to the last.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void advance(int n);
|
|
```
|
|
Advances the value by the specified amount, wrapping if necessary.
|
|
|
|
## Access
|
|
```cpp
|
|
T get() const;
|
|
```
|
|
Gets the current value
|
|
|
|
---
|
|
|
|
```cpp
|
|
T first() const;
|
|
```
|
|
Sets the current value to the first value
|
|
|
|
---
|
|
|
|
```cpp
|
|
T last() const;
|
|
```
|
|
Sets the current value to the last value
|
|
|
|
---
|
|
|
|
```cpp
|
|
void set(T first, T last);
|
|
```
|
|
Sets the new first and last values. Sets the current value to first.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void set(T value);
|
|
```
|
|
Sets the current value.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void to_first();
|
|
```
|
|
Sets the current value to the first value
|
|
|
|
---
|
|
|
|
```cpp
|
|
void to_last();
|
|
```
|
|
Sets the current value to the last value
|
|
|
|
## Operations
|
|
|
|
```cpp
|
|
void swap(cyclic_value<T, FIRST, LAST>& other);
|
|
```
|
|
Swaps with another cyclic value.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void swap(cyclic_value<T, FIRST, LAST>& lhs, cyclic_value<T, FIRST, LAST>& rhs);
|
|
```
|
|
Swaps with another cyclic value.
|
|
|
|
## Operators
|
|
```cpp
|
|
operator T();
|
|
operator const T() const;
|
|
```
|
|
Conversion operators to `T`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
cyclic_value& operator =(T t);
|
|
```
|
|
Sets the current value to `t`.
|
|
|
|
## Non-member functions
|
|
```cpp
|
|
template <typename T, const T FIRST, const T LAST>
|
|
void swap(cyclic_value<T, FIRST, LAST>& lhs, cyclic_value<T, FIRST, LAST>& rhs)
|
|
```
|
|
Swaps two cyclic values.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, const T FIRST, const T LAST>
|
|
bool operator == (cyclic_value<T, FIRST, LAST>& lhs, cyclic_value<T, FIRST, LAST>& rhs)
|
|
```
|
|
Checks equality of two cyclic values.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename T, const T FIRST, const T LAST>
|
|
bool operator != (cyclic_value<T, FIRST, LAST>& lhs, cyclic_value<T, FIRST, LAST>& rhs)
|
|
```
|
|
Checks inequality of two cyclic values.
|