TextFileSeedReader Class Reference

Inherits SeedReader.

Inheritance diagram for TextFileSeedReader:

[legend]List of all members.

---

Detailed Description

Reader for white-space delimited seed data files.

The ordered rows of the file represent time steps, while each column represents a particular seed.

Author:

Lawrence Murray <lawrence@indii.org>

Version:

Rev

307

Date:

Date

2007-09-27 21:21:20 +0100 (Thu, 27 Sep 2007)

Definition at line 24 of file TextFileSeedReader.hpp.

Public Member Functions
	TextFileSeedReader (std::istream *in)
	Construct new seed reader from input stream, where all seeds are of interest.
	TextFileSeedReader (const std::string file)
	Construct new seed reader from file, where all seeds are of interest.
	TextFileSeedReader (std::istream *in, unsigned int seed)
	Construct new seed reader from input stream, where only a single seed is of interest.
	TextFileSeedReader (const std::string file, unsigned int seed)
	Construct new seed reader from file, where only a single seed is of interest.
	TextFileSeedReader (std::istream *in, const std::vector< unsigned int > seeds)
	Construct new seed reader from input stream, where only a subset of seeds are of interest.
	TextFileSeedReader (const std::string file, const std::vector< unsigned int > seeds)
	Construct new seed reader from file, where only a subset of seeds are of interest.
	~TextFileSeedReader ()
	Destructor.
virtual unsigned int	read (double *into)
	Read next value.
virtual unsigned int	read (indii::ml::aux::vector *into)
	Read next values into vector.
virtual unsigned int	read (indii::ml::aux::matrix *into)
	Read next values into matrix.
virtual unsigned int	read (indii::ml::aux::symmetric_matrix *into)
	Read next values into symmetric matrix.

---

Constructor & Destructor Documentation

TextFileSeedReader

(

std::istream *

in

)

Construct new seed reader from input stream, where all seeds are of interest.

Parameters:

in

Stream from which to read.

Definition at line 7 of file TextFileSeedReader.cpp.

TextFileSeedReader

(

const std::string

file

)

Construct new seed reader from file, where all seeds are of interest.

Parameters:

file

Name of file from which to read.

Definition at line 11 of file TextFileSeedReader.cpp.

TextFileSeedReader	(	std::istream *	in,
		unsigned int	seed
	)

Construct new seed reader from input stream, where only a single seed is of interest.

Parameters:

	in	Stream from which to read.
	seed	Index of seed of interest.

Definition at line 15 of file TextFileSeedReader.cpp.

TextFileSeedReader	(	const std::string	file,
		unsigned int	seed
	)

Construct new seed reader from file, where only a single seed is of interest.

Parameters:

	file	Name of file from which to read.
	seed	Index of seed of interest.

Definition at line 20 of file TextFileSeedReader.cpp.

TextFileSeedReader	(	std::istream *	in,
		const std::vector< unsigned int >	seeds
	)

Construct new seed reader from input stream, where only a subset of seeds are of interest.

Parameters:

	in	Stream from which to read.
	seeds	Set of indices giving seeds of interest.

Definition at line 25 of file TextFileSeedReader.cpp.

TextFileSeedReader	(	const std::string	file,
		const std::vector< unsigned int >	seeds
	)

Construct new seed reader from file, where only a subset of seeds are of interest.

Parameters:

	file	Name of file from which to read.
	seeds	Set of indices giving seeds of interest.

Definition at line 30 of file TextFileSeedReader.cpp.

~TextFileSeedReader

(

)

Destructor.

Definition at line 35 of file TextFileSeedReader.cpp.

---

Member Function Documentation

unsigned int read

(

double *

into

)

[virtual]

Read next value.

Parameters:

into

Double into which to read the value.

Returns:

Number of values actually read. Will be 1 if a value is successfully read, and 0 if the end of the stream is reached during reading.

One value is read from the input stream into into. If a particular seed or subset of seeds of interest have been specified, all others are skipped during the reading.

Implements SeedReader.

Definition at line 39 of file TextFileSeedReader.cpp.

virtual unsigned int read

(

indii::ml::aux::vector *

into

)

[virtual]

Read next values into vector.

Parameters:

into

Vector into which to read the values.

Returns:

Number of values actually read. Will be less than the size of the given vector if the end of the stream is reached during reading.

into.size() values are read from the input stream into into. If a particular seed or subset of seeds of interest have been specified, all others are skipped during the reading.

Implements SeedReader.

virtual unsigned int read

(

indii::ml::aux::matrix *

into

)

[virtual]

Read next values into matrix.

Parameters:

into

Matrix into which to read the values.

Returns:

Number of values actually read. Will be less than the size of the given matrix if the end of the stream is reached during reading.

into.size1() * into.size2() values are read from the input stream into into in column-wise fashion. If a particular seed or subset of seeds of interest have been specified, all others are skipped during the reading.

Implements SeedReader.

virtual unsigned int read

(

indii::ml::aux::symmetric_matrix *

into

)

[virtual]

Read next values into symmetric matrix.

Parameters:

into

Matrix into which to read the values.

Returns:

Number of values actually read. Will be less than the size of the lower triangular portion of the given matrix if the end of the stream is reached during reading.

0.5 * (into.size1() * into.size1() + into.size1()) values are read from the input stream into the lower triangle of into in column-wise fashion. If a particular seed or subset of seeds of interest have been specified, all others are skipped during the reading.

Implements SeedReader.

---

The documentation for this class was generated from the following files:

• indii/fmri/data/TextFileSeedReader.hpp
• indii/fmri/data/TextFileSeedReader.cpp

---