gum::learning::DBRowGenerator4CompleteRows< ALLOC > Class Template Reference

A DBRowGenerator class that returns the rows that are complete (fully observed) w.r.t. More...

#include <agrum/tools/database/DBRowGenerator4CompleteRows.h>

Inheritance diagram for gum::learning::DBRowGenerator4CompleteRows< ALLOC >:

Collaboration diagram for gum::learning::DBRowGenerator4CompleteRows< ALLOC >:

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

Public Types
using	allocator_type = ALLOC< DBTranslatedValue >
	type for the allocators passed in arguments of methods More...

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 More...
std::vector< DBTranslatedValueType, ALLOC< DBTranslatedValueType > >	column_types_
	the types of the columns in the DatabaseTable More...
std::vector< std::size_t, ALLOC< std::size_t > >	columns_of_interest_
	the set of columns of interest More...
DBRowGeneratorGoal	goal_ {DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES}
	the goal of the DBRowGenerator (just remove missing values or not) More...

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

Detailed Description

template<template< typename > class ALLOC = std::allocator>
class gum::learning::DBRowGenerator4CompleteRows< ALLOC >

A DBRowGenerator class that returns the rows that are complete (fully observed) w.r.t.

the nodes of interest

This class is a DBRowGenerator that returns all the rows that are complete (i.e., fully observed) w.r.t. the nodes of interest. In other words, whenever the values of the nodes of interest are observed in a row, this one is returned, but if at least one node is unobserved, the generator does not return anything. This class is useful for bootstraping EM algorithms.

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::DBRowGenerator4CompleteRows<> generator ( col_types );

// parse the database and produce output rows
for ( auto dbrow : database ) {
  generator.setInputRow ( dbrow );
  if ( generator.hasRows() ) {
    const auto& output_dbrow = generator.generate ();
    // do something with the output dbrow
  }
}

Definition at line 79 of file DBRowGenerator4CompleteRows.h.

Member Typedef Documentation

allocator_type

template<template< typename > class ALLOC = std::allocator>

using gum::learning::DBRowGenerator4CompleteRows< ALLOC >::allocator_type = ALLOC< DBTranslatedValue >

type for the allocators passed in arguments of methods

Definition at line 82 of file DBRowGenerator4CompleteRows.h.

Constructor & Destructor Documentation

DBRowGenerator4CompleteRows() [1/5]

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::DBRowGenerator4CompleteRows	(	const std::vector< DBTranslatedValueType, ALLOC< DBTranslatedValueType > >	column_types,
		const allocator_type &	alloc = allocator_type()
	)

default constructor

DBRowGenerator4CompleteRows() [2/5]

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::DBRowGenerator4CompleteRows

(

const DBRowGenerator4CompleteRows< ALLOC > &

from

)

copy constructor

DBRowGenerator4CompleteRows() [3/5]

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::DBRowGenerator4CompleteRows	(	const DBRowGenerator4CompleteRows< ALLOC > &	from,
		const allocator_type &	alloc
	)

copy constructor with a given allocator

DBRowGenerator4CompleteRows() [4/5]

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::DBRowGenerator4CompleteRows

(

DBRowGenerator4CompleteRows< ALLOC > &&

from

)

move constructor

DBRowGenerator4CompleteRows() [5/5]

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::DBRowGenerator4CompleteRows	(	DBRowGenerator4CompleteRows< ALLOC > &&	from,
		const allocator_type &	alloc
	)

move constructor with a given allocator

~DBRowGenerator4CompleteRows()

template<template< typename > class ALLOC = std::allocator>

gum::learning::DBRowGenerator4CompleteRows< ALLOC >::~DBRowGenerator4CompleteRows

(

)

destructor

Member Function Documentation

clone() [1/2]

template<template< typename > class ALLOC = std::allocator>

virtual DBRowGenerator4CompleteRows< ALLOC >* gum::learning::DBRowGenerator4CompleteRows< ALLOC >::clone ( ) const

finaloverridevirtual

virtual copy constructor

Implements gum::learning::DBRowGenerator< ALLOC >.

clone() [2/2]

template<template< typename > class ALLOC = std::allocator>

virtual DBRowGenerator4CompleteRows< ALLOC >* gum::learning::DBRowGenerator4CompleteRows< ALLOC >::clone ( const allocator_type &  alloc ) const

finaloverridevirtual

virtual copy constructor with a given allocator

Implements gum::learning::DBRowGenerator< ALLOC >.

columnsOfInterest()

template<template< typename > class ALLOC = std::allocator>

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

inherited

returns the current set of columns of interest

computeRows_()

template<template< typename > class ALLOC = std::allocator>

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

finalprotectedvirtual

computes the rows it will provide as output

Implements gum::learning::DBRowGenerator< ALLOC >.

decreaseRemainingRows()

template<template< typename > class ALLOC = std::allocator>

void gum::learning::DBRowGenerator< ALLOC >::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()

template<template< typename > class ALLOC = std::allocator>

virtual const DBRow< DBTranslatedValue, ALLOC >& gum::learning::DBRowGenerator4CompleteRows< ALLOC >::generate ( )

finalvirtual

generates one ouput DBRow for each DBRow passed to method setInputRow

Warning

if this method is applied while the row it should return is incomplete w.r.t. the nodes of interest, its behavior is uncertain and will certainly result in a segmentation fault

Implements gum::learning::DBRowGenerator< ALLOC >.

getAllocator()

template<template< typename > class ALLOC = std::allocator>

allocator_type gum::learning::DBRowGenerator4CompleteRows< ALLOC >::getAllocator

(

)

const

returns the allocator used

goal()

template<template< typename > class ALLOC = std::allocator>

DBRowGeneratorGoal gum::learning::DBRowGenerator< ALLOC >::goal ( ) const

inherited

returns the goal of the DBRowGenerator

hasRows()

template<template< typename > class ALLOC = std::allocator>

bool gum::learning::DBRowGenerator< ALLOC >::hasRows ( )

inherited

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

operator=() [1/2]

template<template< typename > class ALLOC = std::allocator>

DBRowGenerator4CompleteRows< ALLOC >& gum::learning::DBRowGenerator4CompleteRows< ALLOC >::operator=

(

const DBRowGenerator4CompleteRows< ALLOC > &

from

)

copy operator

operator=() [2/2]

template<template< typename > class ALLOC = std::allocator>

DBRowGenerator4CompleteRows< ALLOC >& gum::learning::DBRowGenerator4CompleteRows< ALLOC >::operator=

(

DBRowGenerator4CompleteRows< ALLOC > &&

from

)

move operator

reset()

template<template< typename > class ALLOC = std::allocator>

virtual void gum::learning::DBRowGenerator< ALLOC >::reset ( )

virtualinherited

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

setColumnsOfInterest() [1/2]

template<template< typename > class ALLOC = std::allocator>

virtual void gum::learning::DBRowGenerator< ALLOC >::setColumnsOfInterest ( const std::vector< std::size_t, ALLOC< 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]

template<template< typename > class ALLOC = std::allocator>

virtual void gum::learning::DBRowGenerator< ALLOC >::setColumnsOfInterest ( std::vector< std::size_t, ALLOC< 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()

template<template< typename > class ALLOC = std::allocator>

bool gum::learning::DBRowGenerator< ALLOC >::setInputRow ( const DBRow< DBTranslatedValue, ALLOC > &  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_

template<template< typename > class ALLOC = std::allocator>

std::vector< DBTranslatedValueType, ALLOC< DBTranslatedValueType > > gum::learning::DBRowGenerator< ALLOC >::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 361 of file DBRowGenerator.h.

columns_of_interest_

template<template< typename > class ALLOC = std::allocator>

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

protectedinherited

the set of columns of interest

Definition at line 364 of file DBRowGenerator.h.

goal_

template<template< typename > class ALLOC = std::allocator>

DBRowGeneratorGoal gum::learning::DBRowGenerator< ALLOC >::goal_ {DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES}

protectedinherited

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

Definition at line 367 of file DBRowGenerator.h.

nb_remaining_output_rows_

template<template< typename > class ALLOC = std::allocator>

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

protectedinherited

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

Definition at line 356 of file DBRowGenerator.h.

---

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

• agrum/tools/database/DBRowGenerator4CompleteRows.h