Programming Reference:BlockRandSeq Class - Revision history

Mellinger: /* Location */

2008-08-19T12:52:20Z

Location

← Older revision		Revision as of 12:52, 19 August 2008
Line 1:		Line 1:
	==Location==		==Location==
	<tt>BCI2000/srcrc/shared/modules/application/utils~~/BlockRandSeq~~</tt>		<tt>BCI2000/srcrc/shared/modules/application/utils</tt>

	==Synopsis==		==Synopsis==

Mellinger: /* Synopsis */

2008-08-14T17:32:40Z

Synopsis

← Older revision		Revision as of 17:32, 14 August 2008
Line 7:		Line 7:
	*a list of absolute frequencies.		*a list of absolute frequencies.
	In the first case, the generated sequence will consist of random permutations of the numbers 1..N, following each other indefinitely.		In the first case, the generated sequence will consist of random permutations of the numbers 1..N, following each other indefinitely.
	In the second case, the generated sequence will be specified by a list of frequencies <math>~~f_k�~~\geq 0</math> for the numbers <math>1..k</math>, and the sequence itself consist of random permutations of the number sequence <math>1..N</math> with each number repeated <math>f_k</math> times.		In the second case, the generated sequence will be specified by a list of frequencies <math>f_k\geq 0</math> for the numbers <math>1..k</math>, and the sequence itself consist of random permutations of the number sequence <math>1..N</math> with each number repeated <math>f_k</math> times.

	==Properties==		==Properties==

Mellinger at 17:32, 14 August 2008

2008-08-14T17:32:25Z

New page

==Location==
<tt>BCI2000/srcrc/shared/modules/application/utils/BlockRandSeq</tt>

==Synopsis==
The <tt>BlockRandSeq</tt> class generates block randomized sequences. Sequences may be specified by
*the number of elements, or
*a list of absolute frequencies.
In the first case, the generated sequence will consist of random permutations of the numbers 1..N, following each other indefinitely.
In the second case, the generated sequence will be specified by a list of frequencies <math>f_k�\geq 0</math> for the numbers <math>1..k</math>, and the sequence itself consist of random permutations of the number sequence <math>1..N</math> with each number repeated <math>f_k</math> times.

==Properties==
For each property, there is a getter method carrying the plain property name. Writable properties have an additional setter method prefixed with "Set".
===int BlockSize (rw)===
The length of a block, i.e. the number of elements in the output before the next permutation begins.
===list Frequencies (r)===
A list of frequencies <math>f_k</math> as specified above. The actual list argument to the setter function may be any STL container class.

==Methods==
===BlockRandSeq( RandomGenerator& )===
The <tt>BlockRandSeq</tt> object uses a [[Programming Reference:RandomGenerator Class|<tt>RandomGenerator</tt>]] object to determine random permutations. In the constructor, a reference to a valid <tt>RandomGenerator</tt> object must be specified. This <tt>RandomGenerator</tt> object must remain valid during the entire lifetime of the <tt>BlockRandSeq</tt> object.

===unsigned int NextElement()===
Returns the next element in the block randomized sequence.

==See also==
[[Programming Reference:ApplicationBase Class]], [[Programming Reference:RandomGenerator Class]]

[[Category:Framework API]][[Category:Development]]