Writer Class Reference

Inheritance diagram for Writer:

[legend]

List of all members.

---

Detailed Description

Abstract writer for data files.

Author:

Lawrence Murray <lawrence@indii.org>

Version:

Rev

Date:

Date

Definition at line 20 of file Writer.hpp.

Public Member Functions
	Writer (std::ostream *out)
	Construct from output stream.
	Writer (const std::string file)
	Construct from file.
virtual	~Writer ()
	Destructor.
virtual void	write (const double value)=0
	Write single value.
virtual void	write (const indii::ml::aux::vector &values)=0
	Write vector of values.
virtual void	write (const indii::ml::aux::matrix &values)=0
	Write matrix of values.
virtual void	write (const indii::ml::aux::symmetric_matrix &values)=0
	Write symmetric matrix of values.
virtual void	writeLine ()=0
	Write the end of the current line and begin a new line.
void	writeLine (const double value)
	Convenience method equivalent to calling write(const double) then writeLine().
void	writeLine (const indii::ml::aux::vector &values)
	Convenience method equivalent to calling write(const indii::ml::aux::vector) then writeLine().
void	writeLine (const indii::ml::aux::matrix &values)
	Convenience method equivalent to calling write(const indii::ml::aux::matrix) then writeLine().
void	writeLine (const indii::ml::aux::symmetric_matrix &values)
	Convenience method equivalent to calling write(const indii::ml::aux::symmetric_matrix) then writeLine().
Protected Attributes
std::ostream *	out
	The output stream.

---

Constructor & Destructor Documentation

Writer

(

std::ostream *

out

)

Construct from output stream.

Parameters:

out

Stream to which to write.

Definition at line 11 of file Writer.cpp.

Writer

(

const std::string

file

)

Construct from file.

Parameters:

file

Name of file to which to write.

Definition at line 15 of file Writer.cpp.

~Writer

(

)

[virtual]

Destructor.

The output stream is closed if the object was created using a file name, but left open otherwise.

Definition at line 19 of file Writer.cpp.

---

Member Function Documentation

virtual void write

(

const double

value

)

[pure virtual]

Write single value.

Parameters:

value

Value to write.

Implemented in TextFileWriter.

virtual void write

(

const indii::ml::aux::vector &

values

)

[pure virtual]

Write vector of values.

All values are written to the current line.

Parameters:

values

Vector of values to write.

Implemented in TextFileWriter.

virtual void write

(

const indii::ml::aux::matrix &

values

)

[pure virtual]

Write matrix of values.

All values are written to the current line in column-wise fashion.

Parameters:

values

Matrix of values to write.

Implemented in TextFileWriter.

virtual void write

(

const indii::ml::aux::symmetric_matrix &

values

)

[pure virtual]

Write symmetric matrix of values.

All values from the lower triangle of the matrix are written to the current line in column-wise fashion.

Parameters:

values

Matrix of values to write.

Implemented in TextFileWriter.

virtual void writeLine

(

)

[pure virtual]

Write the end of the current line and begin a new line.

Implemented in TextFileWriter.

void writeLine

(

const double

value

)

Convenience method equivalent to calling write(const double) then writeLine().

Definition at line 26 of file Writer.cpp.

void writeLine

(

const indii::ml::aux::vector &

values

)

Convenience method equivalent to calling write(const indii::ml::aux::vector) then writeLine().

Definition at line 31 of file Writer.cpp.

void writeLine

(

const indii::ml::aux::matrix &

values

)

Convenience method equivalent to calling write(const indii::ml::aux::matrix) then writeLine().

Definition at line 36 of file Writer.cpp.

void writeLine

(

const indii::ml::aux::symmetric_matrix &

values

)

Convenience method equivalent to calling write(const indii::ml::aux::symmetric_matrix) then writeLine().

Definition at line 41 of file Writer.cpp.

---

Member Data Documentation

std::ostream* out [protected]

The output stream.

Definition at line 107 of file Writer.hpp.

---