gum::learning::DBRowGeneratorIdentity Class Reference

A DBRowGenerator class that returns exactly the rows it gets in input. More...

#include <agrum/base/database/DBRowGeneratorIdentity.h>

Inheritance diagram for gum::learning::DBRowGeneratorIdentity:

Collaboration diagram for gum::learning::DBRowGeneratorIdentity:

Public Member Functions
Constructors / Destructors
	DBRowGeneratorIdentity (const std::vector< DBTranslatedValueType > &column_types)
	default constructor
	DBRowGeneratorIdentity (const DBRowGeneratorIdentity &from)
	copy constructor
	DBRowGeneratorIdentity (DBRowGeneratorIdentity &&from)
	move constructor
DBRowGeneratorIdentity *	clone () const final
	virtual copy constructor
	~DBRowGeneratorIdentity ()
	destructor
Operators
DBRowGeneratorIdentity &	operator= (const DBRowGeneratorIdentity &from)
	copy operator
DBRowGeneratorIdentity &	operator= (DBRowGeneratorIdentity &&from)
	move operator
Accessors / Modifiers
virtual const DBRow< DBTranslatedValue > &	generate () final
	generates one ouput DBRow for each DBRow passed to method setInputRow
Accessors / Modifiers
bool	hasRows ()
	returns true if there are still rows that can be output by the DBRowGenerator
bool	setInputRow (const DBRow< DBTranslatedValue > &row)
	sets the input row from which the generator will create its output rows
void	decreaseRemainingRows ()
	decrease the number of remaining output rows
virtual void	reset ()
	resets the generator. There are therefore no more ouput row to generate
virtual void	setColumnsOfInterest (const std::vector< std::size_t > &cols_of_interest)
	sets the columns of interest: the output DBRow needs only contain correct values fot these columns
virtual void	setColumnsOfInterest (std::vector< std::size_t > &&cols_of_interest)
	sets the columns of interest: the output DBRow needs only contain correct values fot these columns
const std::vector< std::size_t > &	columnsOfInterest () const
	returns the current set of columns of interest
DBRowGeneratorGoal	goal () const
	returns the goal of the DBRowGenerator

Protected Member Functions
virtual std::size_t	computeRows_ (const DBRow< DBTranslatedValue > &row) final
	computes the rows it will provide as output

Protected Attributes
std::size_t	nb_remaining_output_rows_ {std::size_t(0)}
	the number of output rows still to retrieve through the generate method
std::vector< DBTranslatedValueType >	column_types_
	the types of the columns in the DatabaseTable
std::vector< std::size_t >	columns_of_interest_
	the set of columns of interest
DBRowGeneratorGoal	goal_ {DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES}
	the goal of the DBRowGenerator (just remove missing values or not)

Detailed Description

A DBRowGenerator class that returns exactly the rows it gets in input.

This class is a dummy DBRowGenerator that can be essentially used for debugging purposes. The DBRowGeneratorIdentity class is designed to take as input DBRow instances via its method setInputRow and to ouput them without any additional processing via its method generate. See class DBRowGenerator for further details on how DBRowGenerator works.

The standard usage of a DBRowGenerator is the following:

// create a DatabaseTable and fill it
gum::learning::DBTranslatorSet set;
for ( int i = 0; i < 10; ++i )
  set.insertTranslator(gum::learning::DBTranslator4LabelizedVariable(),i);
gum::learning::DatabaseTable database ( set );
// fill the database
 
// keep in a vector the types of the columns in the database
const std::vector<gum::learning::DBTranslatedValueType>
  column_types ( 10, gum::learning::DBTranslatedValueType::DISCRETE );
 
// create the generator
gum::learning::DBRowGeneratorIdentity generator ( col_types );
 
// parse the database and produce output rows
for ( auto dbrow : database ) {
  generator.setInputRow ( dbrow );
  const auto& output_dbrow = generator.generate ();
  // do something with the output dbrow
}

Definition at line 95 of file DBRowGeneratorIdentity.h.

Constructor & Destructor Documentation

DBRowGeneratorIdentity() [1/3]

gum::learning::DBRowGeneratorIdentity::DBRowGeneratorIdentity

(

const std::vector< DBTranslatedValueType > &

column_types

)

default constructor

Referenced by DBRowGeneratorIdentity(), DBRowGeneratorIdentity(), ~DBRowGeneratorIdentity(), clone(), operator=(), and operator=().

Here is the caller graph for this function:

DBRowGeneratorIdentity() [2/3]

gum::learning::DBRowGeneratorIdentity::DBRowGeneratorIdentity

(

const DBRowGeneratorIdentity &

from

)

copy constructor

References DBRowGeneratorIdentity().

Here is the call graph for this function:

DBRowGeneratorIdentity() [3/3]

gum::learning::DBRowGeneratorIdentity::DBRowGeneratorIdentity

(

DBRowGeneratorIdentity &&

from

)

move constructor

References DBRowGeneratorIdentity().

Here is the call graph for this function:

~DBRowGeneratorIdentity()

gum::learning::DBRowGeneratorIdentity::~DBRowGeneratorIdentity

(

)

destructor

References DBRowGeneratorIdentity().

Here is the call graph for this function:

Member Function Documentation

clone()

DBRowGeneratorIdentity * gum::learning::DBRowGeneratorIdentity::clone ( ) const

finalvirtual

virtual copy constructor

Implements gum::learning::DBRowGenerator.

References DBRowGeneratorIdentity().

Here is the call graph for this function:

columnsOfInterest()

const std::vector< std::size_t > & gum::learning::DBRowGenerator::columnsOfInterest ( ) const

inherited

returns the current set of columns of interest

computeRows_()

virtual std::size_t gum::learning::DBRowGeneratorIdentity::computeRows_ ( const DBRow< DBTranslatedValue > & row )

finalprotectedvirtual

computes the rows it will provide as output

Implements gum::learning::DBRowGenerator.

References computeRows_().

Referenced by computeRows_().

Here is the call graph for this function:

Here is the caller graph for this function:

decreaseRemainingRows()

void gum::learning::DBRowGenerator::decreaseRemainingRows ( )

inherited

decrease the number of remaining output rows

When method setInputRow is performed, the DBRowGenerator knows how many output rows it will be able to generate. Each time method decreaseRemainingRows is called, we decrement this number. When the number becomes equal to 0, then there remains no new output row to generate.

generate()

virtual const DBRow< DBTranslatedValue > & gum::learning::DBRowGeneratorIdentity::generate ( )

finalvirtual

generates one ouput DBRow for each DBRow passed to method setInputRow

Implements gum::learning::DBRowGenerator.

References generate().

Referenced by generate().

Here is the call graph for this function:

Here is the caller graph for this function:

goal()

DBRowGeneratorGoal gum::learning::DBRowGenerator::goal ( ) const

inherited

returns the goal of the DBRowGenerator

Referenced by DBRowGenerator(), and gum::learning::DBRowGeneratorWithBN< GUM_SCALAR >::DBRowGeneratorWithBN().

Here is the caller graph for this function:

hasRows()

bool gum::learning::DBRowGenerator::hasRows ( )

inherited

returns true if there are still rows that can be output by the DBRowGenerator

operator=() [1/2]

DBRowGeneratorIdentity & gum::learning::DBRowGeneratorIdentity::operator=

(

const DBRowGeneratorIdentity &

from

)

copy operator

References DBRowGeneratorIdentity().

Here is the call graph for this function:

operator=() [2/2]

DBRowGeneratorIdentity & gum::learning::DBRowGeneratorIdentity::operator=

(

DBRowGeneratorIdentity &&

from

)

move operator

References DBRowGeneratorIdentity().

Here is the call graph for this function:

reset()

virtual void gum::learning::DBRowGenerator::reset ( )

virtualinherited

resets the generator. There are therefore no more ouput row to generate

setColumnsOfInterest() [1/2]

virtual void gum::learning::DBRowGenerator::setColumnsOfInterest ( const std::vector< std::size_t > & cols_of_interest )

virtualinherited

sets the columns of interest: the output DBRow needs only contain correct values fot these columns

This method is useful, e.g., for EM-like algorithms that need to know which unobserved variables/values need be filled. In this case, the DBRowGenerator still outputs DBRows with the same columns as the DatabaseTable, but only the columns of these DBRows corresponding to those passed in argument to Method setColumnsOfInterest are meaningful. For instance, if a DatabaseTable contains 10 columns and Method setColumnsOfInterest() is applied with vector<> { 0, 3, 4 }, then the DBRowGenerator will output DBRows with 10 columns, in which only columns 0, 3 and 4 are guaranteed to have correct values (columns are always indexed, starting from 0).

setColumnsOfInterest() [2/2]

virtual void gum::learning::DBRowGenerator::setColumnsOfInterest ( std::vector< std::size_t > && cols_of_interest )

virtualinherited

sets the columns of interest: the output DBRow needs only contain correct values fot these columns

This method is useful, e.g., for EM-like algorithms that need to know which unobserved variables/values need be filled. In this case, the DBRowGenerator still outputs DBRows with the same columns as the DatabaseTable, but only the columns of these DBRows corresponding to those passed in argument to Method setColumnsOfInterest are meaningful. For instance, if a DatabaseTable contains 10 columns and Method setColumnsOfInterest() is applied with vector<> { 0, 3, 4 }, then the DBRowGenerator will output DBRows with 10 columns, in which only columns 0, 3 and 4 are guaranteed to have correct values (columns are always indexed, starting from 0).

setInputRow()

bool gum::learning::DBRowGenerator::setInputRow ( const DBRow< DBTranslatedValue > & row )

inherited

sets the input row from which the generator will create its output rows

Returns

a Boolean indicating whether, from this input DBRow, the DBRowGenerator is capable of outputing at least one row or not

Member Data Documentation

column_types_

std::vector< DBTranslatedValueType > gum::learning::DBRowGenerator::column_types_

protectedinherited

the types of the columns in the DatabaseTable

This is useful to determine whether we need to use the .discr_val field or the .cont_val field in DBTranslatedValue instances.

Definition at line 330 of file DBRowGenerator.h.

columns_of_interest_

std::vector< std::size_t > gum::learning::DBRowGenerator::columns_of_interest_

protectedinherited

the set of columns of interest

Definition at line 333 of file DBRowGenerator.h.

goal_

DBRowGeneratorGoal gum::learning::DBRowGenerator::goal_ {DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES}

protectedinherited

the goal of the DBRowGenerator (just remove missing values or not)

Definition at line 336 of file DBRowGenerator.h.

{DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES};

nb_remaining_output_rows_

std::size_t gum::learning::DBRowGenerator::nb_remaining_output_rows_ {std::size_t(0)}

protectedinherited

the number of output rows still to retrieve through the generate method

Definition at line 325 of file DBRowGenerator.h.

{std::size_t(0)};

---

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

• agrum/base/database/DBRowGeneratorIdentity.h