Group Position Calculation
Position calculation functions.

Grouped Function Overview

Grouped Functions Detail

TPos posAdd(pos, delta);

Defined in
<seqan/sequence.h>
Returns a position where the local offset is increased by a value delta.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs).
delta Increase the local offset of pos by this value.

Returns

TPos Returns a value of the same type as pos where seqOfs is increased by delta.

Data Races

Thread safety unknown!

See Also

bool posAddAndCheck(pos, delta, text);

Defined in
<seqan/sequence.h>
Increases the local offset of a position by a value delta and check for overflow.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs).
delta Increase the local offset of pos by this value.
text The text to use for checking.

Data Races

Thread safety unknown!

See Also

void posInc(pos);

Defined in
<seqan/sequence.h>
Increments the local offset of a position type.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs). In both cases, seqOfs will be incremented by one.

Data Races

Thread safety unknown!

See Also

TPos posNext(pos);

Defined in
<seqan/sequence.h>
Returns a position where the local offset is increased by one.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs).

Returns

TPos Returns a value of the same type as pos where seqOfs is increased by one.

Data Races

Thread safety unknown!

See Also

TPos posPrev(pos);

Defined in
<seqan/sequence.h>
Returns a position where the local offset is decreased by one.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs).

Returns

TPos The predecessor. TPos is the type of pos.

Data Races

Thread safety unknown!

See Also

TPos posSub(pos, delta);

Defined in
<seqan/sequence.h>
Returns a position where the local offset is decreased by a value delta.

Parameters

pos A position type, an integer with seqOfs or a pair (seqNo, seqOfs).
delta Decrease the local offset of pos by this value.

Returns

TPos Returns a value of the same type as pos where seqOfs is decreased by delta.

Data Races

Thread safety unknown!

See Also