The AnalysisResults class A container for a mat object that allows a mat to be copied to a heap-allocated object (this) so pointers to that mat cannot go out of scope. These objects should be heap-allocated inside smart pointers. More...

#include <analysisresults.h>

Inheritance diagram for AnalysisResults:

Public Member Functions
	AnalysisResults (QString name, QString type)
	AnalysisResults::AnalysisResults. More...

virtual	~AnalysisResults ()

const mat &	GetMatrix (const QString &key)

void	AddMatrix (const QString &key, const mat &value, QStringList column_headings=QStringList())

void	AddColumns (const QStringList &keys, const mat &value)

void	AddMetadata (QString key, QString value)

void	AddField (const QString &key, const field< mat > &value)

const field< mat > &	GetField (const QString &key)

const mat &	GetFieldElement (const QString &key, const uword &index)

bool	HasField (const QString &key) const

bool	HasMatrix (const QString &key) const

const QStringList	KeyList () const

const QString	name () const

const QString	type () const

const mat &	EmptyMatrix ()

const QMap< QString, QString >	GetMetadata () const

const QString	GetColumnHeading (const QString &key, int column)

const QString	GetRowHeading (const QString &key, int row)

void	SetName (const QString &new_name)

void	SetType (const QString &new_type)

QSharedPointer< AnalysisResults >	Subset (QStringList matrices, uword start_row, uword end_row)

void	AddParent (QString key, uword start_row, uword end_row)

QMap< QString, uvec >	parent_rows ()

bool	Concatenate (QSharedPointer< AnalysisResults > other)
	AnalysisResults::Concatenate. More...

QSharedPointer< AnalysisResults >	Replicate ()
	AnalysisResults::Replicate. More...

void	RemoveMatrix (const QString &key)

Detailed Description

The AnalysisResults class A container for a mat object that allows a mat to be copied to a heap-allocated object (this) so pointers to that mat cannot go out of scope. These objects should be heap-allocated inside smart pointers.

Definition at line 34 of file analysisresults.h.

Constructor & Destructor Documentation

AnalysisResults::AnalysisResults	(	QString	name,
		QString	type
	)

AnalysisResults::AnalysisResults.

Parameters

name
type	Base constructor

Definition at line 8 of file analysisresults.cpp.

AnalysisResults::~AnalysisResults ( )

virtual

Definition at line 16 of file analysisresults.cpp.

Member Function Documentation

void AnalysisResults::AddColumns	(	const QStringList &	keys,
		const mat &	value
	)

Definition at line 65 of file analysisresults.cpp.

void AnalysisResults::AddField	(	const QString &	key,
		const field< mat > &	value
	)

Definition at line 32 of file analysisresults.cpp.

void AnalysisResults::AddMatrix	(	const QString &	key,
		const mat &	value,
		QStringList	column_headings = `QStringList()`
	)

Definition at line 59 of file analysisresults.cpp.

void AnalysisResults::AddMetadata	(	QString	key,
		QString	value
	)

Definition at line 27 of file analysisresults.cpp.

void AnalysisResults::AddParent	(	QString	key,
		uword	start_row,
		uword	end_row
	)

Definition at line 133 of file analysisresults.cpp.

bool AnalysisResults::Concatenate ( QSharedPointer< AnalysisResults > other )

AnalysisResults::Concatenate.

Parameters

other Merge the matrices of other into the same-named matrices of this one Will perform a check of mergability for every matrix before performing merge Non mergable matrices are removed from this result.

Definition at line 149 of file analysisresults.cpp.

const mat & AnalysisResults::EmptyMatrix ( )

Definition at line 89 of file analysisresults.cpp.

const QString AnalysisResults::GetColumnHeading	(	const QString &	key,
		int	column
	)

Definition at line 99 of file analysisresults.cpp.

const field< mat > & AnalysisResults::GetField ( const QString & key )

Definition at line 37 of file analysisresults.cpp.

const mat & AnalysisResults::GetFieldElement	(	const QString &	key,
		const uword &	index
	)

Definition at line 42 of file analysisresults.cpp.

const mat & AnalysisResults::GetMatrix ( const QString & key )

Definition at line 21 of file analysisresults.cpp.

const QMap< QString, QString > AnalysisResults::GetMetadata ( ) const

Definition at line 94 of file analysisresults.cpp.

const QString AnalysisResults::GetRowHeading	(	const QString &	key,
		int	row
	)

Definition at line 106 of file analysisresults.cpp.

bool AnalysisResults::HasField ( const QString & key ) const

Definition at line 49 of file analysisresults.cpp.

bool AnalysisResults::HasMatrix ( const QString & key ) const

Definition at line 54 of file analysisresults.cpp.

const QStringList AnalysisResults::KeyList ( ) const

Definition at line 74 of file analysisresults.cpp.

const QString AnalysisResults::name ( ) const

Definition at line 79 of file analysisresults.cpp.

QMap< QString, uvec > AnalysisResults::parent_rows ( )

Definition at line 138 of file analysisresults.cpp.

void AnalysisResults::RemoveMatrix ( const QString & key )

Definition at line 184 of file analysisresults.cpp.

QSharedPointer< AnalysisResults > AnalysisResults::Replicate ( )

AnalysisResults::Replicate.

Returns: Used in lieu of a copy constructor. Does not produce a perfect copy but does copy name, type, matrices, etc. does not replicate most metadata

Definition at line 175 of file analysisresults.cpp.

void AnalysisResults::SetName ( const QString & new_name )

Definition at line 113 of file analysisresults.cpp.

void AnalysisResults::SetType ( const QString & new_type )

Definition at line 118 of file analysisresults.cpp.

QSharedPointer< AnalysisResults > AnalysisResults::Subset	(	QStringList	matrices,
		uword	start_row,
		uword	end_row
	)

Definition at line 123 of file analysisresults.cpp.

const QString AnalysisResults::type ( ) const

Definition at line 84 of file analysisresults.cpp.

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

Projects/VespucciProject/Vespucci/Vespucci/Data/Analysis/analysisresults.h
Projects/VespucciProject/Vespucci/Vespucci/Data/Analysis/analysisresults.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation