Class Pool
Pools are push- and pop-passive pipeline modules.

All Subcl's MapperConfig, MapperConfigSize, MapperSpec, PoolConfig, PoolConfigSize, PoolSpec, SorterConfig, SorterConfigSize, SorterSpec
Defined in <seqan/pipe.h>
Signature template <typename TValue[, typename TSpec]> class Pool;

Template Parameters

TSpec The specializing type. Default: PoolSpec<>, see PoolSpec.
TValue The value type, that is the type of the stream elements.

Interface Function Overview

Detailed Description

Use Value to get the output type of a given Pipe (returns Value<TInput>::Type by default).

Use Size to get the size type of a given Pipe (returns Size<TInput>::Type by default).

Interface Functions Detail

void assign(target, source);

Assigns one object to another object.

Parameters

target Reference to assign to.
source Value to assign.

Assign value of source to target.

Data Races

Thread safety unknown!

bool atEnd(pool);

Check whether the Pool object is at end.

Parameters

pool The Pool object to query.

Returns

bool true in case of the pool being at the end, false otherwise.

Data Races

Thread safety unknown!

bool beginRead(pool);

Initiates a read process.

Parameters

pool A pool module.

Returns

bool true on success, false on failure.

A read process must be terminated with endRead. Nested read processes are not allowed.

Data Races

Thread safety unknown!

See Also

bool beginWrite(pool);

Initiates a write process.

Parameters

pool A pool module.

Returns

bool true on success, false on failure.

beginWrite prepares a pool for succeeding writes.

A write process must be terminated with endWrite. Nested write processes are not allowed.

Data Races

Thread safety unknown!

See Also

void clear(pool);

Remove all elements from the pool.

Parameters

pool Pool to clear.

Data Races

Thread safety unknown!

bool endRead(pool);

Terminates a read process.

Parameters

pool A pool module.

Returns

bool true on success, false on failure.

Data Races

Thread safety unknown!

See Also

bool endWrite(pool);

Terminates a write process.

Parameters

pool A push-passive pipeline module.

Returns

bool true on success, false on failure.

endWrite closes the input stream and frees resources possibly allocated by beginWrite

Data Races

Thread safety unknown!

See Also

TReference front(pool);

Return reference to the first element.

Parameters

pool The pool to get the first element of.

Returns

TReference A reference to the first element of seq.

Data Races

Thread safety unknown!

TSize length(pool);

Length of the pool.

Parameters

pool The Pool to query for its size.

Returns

TSize The number of elements in the pool.

Data Races

Thread safety unknown!

void pop(pool[, ref]);

Pops the first element of the remaining stream.

Parameters

pool A pop-passive pipeline module.
ref Reference to the result. Result type is Value<TObject>::Type for object type TObject. Returns the first element of the remaining input stream.

In contrast to Pool#front this function also steps one element further.

Pool#front or Pool#pop can only be called within a read process surrounded by beginRead and endRead.

Data Races

Thread safety unknown!

void push(pool, val);

Appends an item at the end of an input stream.

Parameters

pool A pool module.
val Item to be pushed.

The function push can only be called within a write process surrounded by beginWrite and endWrite.

Data Races

Thread safety unknown!

void resize(pool, len);

Resize a pool.

Parameters

pool Pool to resize.
len Length to resize pool to.

Data Races

Thread safety unknown!