Detailed Description
A read-only, monotonic sequence of values.
Designed to be used as an interpolation axis for a multi-dimensional data sets. Fast interpolation algorithms require an ability to quickly lookup an axis index appropriate given a floating point axis value.
This class is modeled after ublas::vector and as such can be used in a similar fashion to other ublas::vectors.
Member Typedef Documentation
Constructor & Destructor Documentation
Initializes data container.
Copies data from another seq_vector object.
- Parameters:
-
| other | The object to be copied. |
Member Function Documentation
Iterators needed for BOOST_FOREACH.
virtual self_type* clone |
( |
|
) |
const [pure virtual] |
Convert sequence into a normal C++ array.
Search for a value in this sequence.
If the value is outside of the legal range, the index for the nearest endpoint will be returned.
This reverse lookup is the principle feature that distinguishes seq_vector objects from ordinary vectors.
- Parameters:
-
| value | Value of the element to find. |
- Returns:
- Index of the largest value that is not greater than the argument.
Implemented in seq_data, seq_linear, and seq_log.
Retrieves the increment between two elements in this sequence.
If the index is outside of the range [0,size-1), the value for the nearest endpoint will be returned.
- Parameters:
-
| index | The element number to retrieve (zero indexed). |
- Returns:
- The difference between the element at "index" and the element at "index+1".
Retrieves the value at a specified index in the sequence in the safest way possible.
If the index is outside of the range [0,size), the value for the nearest endpoint will be returned.
- Parameters:
-
| index | The index of element to retrieve (zero indexed). |
- Returns:
- The value at the indexed element.
Retrieves the value at a specified index in the sequence in the fastest way possible.
Problems will occur if the index is outside of the range [0,size-1),
- Parameters:
-
| index | The element number to retrieve (zero indexed). |
- Returns:
- The value between the "index" element.
Reverse iterators needed for data_grid _axes call.
Returns the number of elements in this sequence.
Member Data Documentation
Cache of sequence values.
Cache of increment values.
Largest valid index number (one less than size() ).