Class
IntervalAndCargoA simple record type that stores an interval and a cargo value.
A simple record type that stores an interval and a cargo value.
Defined in | <seqan/misc/interval_tree.h> |
---|---|
Signature |
template <[typename TValue[, typename TCargo]]>
class IntervalAndCargo;
|
Member Function Overview
Interface Function Overview
-
TCargo cargo(interval);
Access to the cargo. -
TCargo getCargo(interval);
Access to the cargo. -
TBoundary getLeftBoundary(interval);
Access to getLeft boundary. -
TBoundary getRightBoundary(interval);
Access to getRight boundary. -
TBoundary leftBoundary(interval);
Access to left boundary. -
TBoundary rightBoundary(interval);
Access to right boundary.
Interface Metafunction Overview
-
Cargo<TIntervalAndCargo>::Type;
Return the cargo type. -
Value<TIntervalAndCargo>::Type;
Return the value type.
Member Variable Overview
-
TCargo IntervalAndCargo::cargo
The stored cargo. -
TValue IntervalAndCargo::i1
The first element in the interval. -
TValue IntervalAndCargo::i2
The last element in the interval.
Member Functions Detail
IntervalAndCargo::IntervalAndCargo();
IntervalAndCargo::IntervalAndCargo(i1, i2, cargo);
Constructor
Parameters
i1
|
The first element in the interval. |
---|---|
i2
|
The last element in the interval. |
cargo
|
The cargo to store together with the interval. |
Data Races
Thread safety unknown!
Interface Functions Detail
TCargo cargo(interval);
Access to the cargo.
Parameters
interval
|
The IntervalAndCargo to query for its cargo. |
---|
Returns
TCargo |
Reference to the cargo member. |
---|
Data Races
Thread safety unknown!
TCargo getCargo(interval);
Access to the cargo.
Parameters
interval
|
The IntervalAndCargo to query for its cargo. |
---|
Returns
TCargo |
Copy of the cargo member. |
---|
Data Races
Thread safety unknown!
TBoundary getLeftBoundary(interval);
Access to getLeft boundary.
Parameters
interval
|
The IntervalAndCargo to query for its left boundary. |
---|
Returns
TBoundary |
Copy of the left boundary value. |
---|
Data Races
Thread safety unknown!
TBoundary getRightBoundary(interval);
Access to getRight boundary.
Parameters
interval
|
The IntervalAndCargo to query for its right boundary. |
---|
Returns
TBoundary |
Copy of the right boundary value. |
---|
Data Races
Thread safety unknown!
TBoundary leftBoundary(interval);
Access to left boundary.
Parameters
interval
|
The IntervalAndCargo to query for its left boundary. |
---|
Returns
TBoundary |
Reference to the left boundary value. |
---|
Data Races
Thread safety unknown!
TBoundary rightBoundary(interval);
Access to right boundary.
Parameters
interval
|
The IntervalAndCargo to query for its right boundary. |
---|
Returns
TBoundary |
Reference to the right boundary value. |
---|
Data Races
Thread safety unknown!
Member Variables Detail
TCargo IntervalAndCargo::cargo
The stored cargo.
TValue IntervalAndCargo::i1
The first element in the interval.
TValue IntervalAndCargo::i2
The last element in the interval.