fn_dag::dag< OriginType, IDType > Class Template Reference

The main DAG function that encapulates generation and mapping of the data across the DAG. More...

#include <dag_impl.hpp>

Inheritance diagram for fn_dag::dag< OriginType, IDType >:

Public Member Functions
	dag (const IDType &_id, dag_source< OriginType > *_lsource, const _dag_context &_context, bool _startThread)
	Constructor of the DAG.
	~dag ()
	Default deconstructor.
const IDType &	get_id ()
	Simple getter for the ID of the DAG itself.
void	manual_pump (const unique_ptr< OriginType > _raw_dat)
	Manually pumps some data across the children of the DAG.
bool	dag_contains (const IDType &_id)
	Checks whether this DAG contains a specific ID.
template<typename In, typename Out>
expected< IDType, error_codes >	add_filter (IDType _newID, dag_node< In, Out > *_new_filter, IDType _on_node)
	Adds a new function to the DAG.
void	print ()
	Simple print function to print the ID of this DAG and it's children.
void	push_once ()
	Runs the generator and begins propagating the data to it's children.

Detailed Description

template<typename OriginType, typename IDType>
class fn_dag::dag< OriginType, IDType >

The main DAG function that encapulates generation and mapping of the data across the DAG.

The DAG calls the source generator to generate some data. That data is then propagated to it's children and across the entire DAG. The DAG stops propagating across the children of any node of the DAG if the previous parent returns nullptr. Otherwise, this runs either multithreaded or single threaded and can be manually manipulated (i.e. skip the generator) by turning it off and manually calling the manual_pump function.

Constructor & Destructor Documentation

dag()

template<typename OriginType, typename IDType>

fn_dag::dag< OriginType, IDType >::dag ( const IDType & _id, dag_source< OriginType > * _lsource, const _dag_context & _context, bool _startThread )

inline

Constructor of the DAG.

Ideally this is created in the manager but you can create your own DAG if you'd like.

Parameters

_id	The ID of the DAG itself
_lsource	The main generator (source) of the DAG. Where data originates
_context	The context shared across the DAG
_startThread	Whether or not to autostart calling the generator function

~dag()

template<typename OriginType, typename IDType>

fn_dag::dag< OriginType, IDType >::~dag ( )

inline

Default deconstructor.

Waits for children to stop before cleaning up.

Member Function Documentation

add_filter()

template<typename OriginType, typename IDType>

template<typename In, typename Out>

expected< IDType, error_codes > fn_dag::dag< OriginType, IDType >::add_filter ( IDType _newID, dag_node< In, Out > * _new_filter, IDType _on_node )

inlinenodiscard

Adds a new function to the DAG.

Since the generator already exists, this function recursively calls itself with the parents nodes type and, in a strongly typed way, attaches a child to the parent to process the data output by the parent node.

Parameters

_newID	The ID of the new function
_new_filter	The mapping function itself to pass along
_on_node	The ID of the parent to attach the function to.

Returns

A parent ID if successfully added to the dag. Otherwise an error code.

dag_contains()

template<typename OriginType, typename IDType>

bool fn_dag::dag< OriginType, IDType >::dag_contains ( const IDType & _id )

inline

Checks whether this DAG contains a specific ID.

Given an ID, it will check the optimized hash set to see if the child exists.

Parameters

_id	The ID to lookup

Returns

Whether or not the DAG contains the ID.

get_id()

template<typename OriginType, typename IDType>

const IDType & fn_dag::dag< OriginType, IDType >::get_id ( )

inline

Simple getter for the ID of the DAG itself.

Gets the ID of the DAG.

Returns

ID of the DAG

manual_pump()

template<typename OriginType, typename IDType>

void fn_dag::dag< OriginType, IDType >::manual_pump ( const unique_ptr< OriginType > _raw_dat )

inline

Manually pumps some data across the children of the DAG.

This is a useful function for testing. It skips the generator and pushes the test source data across the DAGs children.

Parameters

_raw_dat

The raw data that the user provides.

push_once()

template<typename OriginType, typename IDType>

void fn_dag::dag< OriginType, IDType >::push_once ( )

inline

Runs the generator and begins propagating the data to it's children.

This function can be called from the thread on a loop or called on a single thread. This encapsulates a single pass across the DAG.