Utility class for creating task graphs. More...

#include <flow.hpp>

Public Types
using	allocator_type = Allocator
	Allocator type.

using	size_type = std::size_t
	Unsigned integer type.

using	iterable = iterable_adaptor<typename task_container_type::const_iterator>
	Iterable task list.

using	graph_type = adjacency_matrix_type
	Adjacency matrix type.

Public Member Functions
	basic_flow ()
	Default constructor.

	basic_flow (const allocator_type &allocator)
	Constructs a flow builder with a given allocator.

	basic_flow (const basic_flow &)=default
	Default copy constructor.

	basic_flow (const basic_flow &other, const allocator_type &allocator)
	Allocator-extended copy constructor.

	basic_flow (basic_flow &&) noexcept=default
	Default move constructor.

	basic_flow (basic_flow &&other, const allocator_type &allocator)
	Allocator-extended move constructor.

	~basic_flow ()=default
	Default destructor.

basic_flow &	operator= (const basic_flow &)=default
	Default copy assignment operator.

basic_flow &	operator= (basic_flow &&) noexcept=default
	Default move assignment operator.

void	swap (basic_flow &other) noexcept
	Exchanges the contents with those of a given flow builder.

constexpr allocator_type	get_allocator () const noexcept
	Returns the associated allocator.

id_type	operator[] (const size_type pos) const
	Returns the identifier at specified location.

void	clear () noexcept
	Clears the flow builder.

bool	empty () const noexcept
	Returns true if a flow builder contains no tasks, false otherwise.

size_type	size () const noexcept
	Returns the number of tasks.

basic_flow &	bind (const id_type value)
	Binds a task to a flow builder.

basic_flow &	sync ()
	Turns the current task into a sync point.

basic_flow &	set (const id_type res, bool is_rw=false)
	Assigns a resource to the current task with a given access mode.

basic_flow &	ro (const id_type res)
	Assigns a read-only resource to the current task.

template<typename It>
std::enable_if_t< std::is_same_v< std::remove_const_t< typename std::iterator_traits< It >::value_type >, id_type >, basic_flow & >	ro (It first, It last)
	Assigns a range of read-only resources to the current task.

basic_flow &	rw (const id_type res)
	Assigns a writable resource to the current task.

template<typename It>
std::enable_if_t< std::is_same_v< std::remove_const_t< typename std::iterator_traits< It >::value_type >, id_type >, basic_flow & >	rw (It first, It last)
	Assigns a range of writable resources to the current task.

graph_type	graph () const
	Generates a task graph for the current content.

Detailed Description

template<typename Allocator>
class entt::basic_flow< Allocator >

Utility class for creating task graphs.

Template Parameters

Allocator Type of allocator used to manage memory and elements.

Definition at line 29 of file flow.hpp.

Member Typedef Documentation

◆ allocator_type

template<typename Allocator>

using entt::basic_flow< Allocator >::allocator_type = Allocator

Allocator type.

Definition at line 119 of file flow.hpp.

◆ graph_type

template<typename Allocator>

using entt::basic_flow< Allocator >::graph_type = adjacency_matrix_type

Adjacency matrix type.

Definition at line 125 of file flow.hpp.

◆ iterable

template<typename Allocator>

using entt::basic_flow< Allocator >::iterable = iterable_adaptor<typename task_container_type::const_iterator>

Iterable task list.

Definition at line 123 of file flow.hpp.

◆ size_type

template<typename Allocator>

using entt::basic_flow< Allocator >::size_type = std::size_t

Unsigned integer type.

Definition at line 121 of file flow.hpp.

Constructor & Destructor Documentation

◆ basic_flow() [1/4]

template<typename Allocator>

entt::basic_flow< Allocator >::basic_flow ( )

inline

Default constructor.

Definition at line 128 of file flow.hpp.

◆ basic_flow() [2/4]

template<typename Allocator>

entt::basic_flow< Allocator >::basic_flow ( const allocator_type & allocator )

inlineexplicit

Constructs a flow builder with a given allocator.

Parameters

allocator The allocator to use.

Definition at line 135 of file flow.hpp.

◆ basic_flow() [3/4]

template<typename Allocator>

entt::basic_flow< Allocator >::basic_flow	(	const basic_flow< Allocator > &	other,
		const allocator_type &	allocator )

inline

Allocator-extended copy constructor.

Parameters

other	The instance to copy from.
allocator	The allocator to use.

Definition at line 148 of file flow.hpp.

◆ basic_flow() [4/4]

template<typename Allocator>

entt::basic_flow< Allocator >::basic_flow	(	basic_flow< Allocator > &&	other,
		const allocator_type &	allocator )

inline

Allocator-extended move constructor.

Parameters

other	The instance to move from.
allocator	The allocator to use.

Definition at line 162 of file flow.hpp.

Member Function Documentation

◆ bind()

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::bind ( const id_type value )

inline

Binds a task to a flow builder.

Parameters

value Task identifier.

Returns: This flow builder.

Definition at line 241 of file flow.hpp.

◆ clear()

template<typename Allocator>

void entt::basic_flow< Allocator >::clear ( )

inlinenoexcept

Clears the flow builder.

Definition at line 213 of file flow.hpp.

◆ empty()

template<typename Allocator>

bool entt::basic_flow< Allocator >::empty ( ) const

inlinenodiscardnoexcept

Returns true if a flow builder contains no tasks, false otherwise.

Returns: True if the flow builder contains no tasks, false otherwise.

Definition at line 224 of file flow.hpp.

◆ get_allocator()

template<typename Allocator>

allocator_type entt::basic_flow< Allocator >::get_allocator ( ) const

inlinenodiscardconstexprnoexcept

Returns the associated allocator.

Returns: The associated allocator.

Definition at line 199 of file flow.hpp.

◆ graph()

template<typename Allocator>

graph_type entt::basic_flow< Allocator >::graph ( ) const

inlinenodiscard

Generates a task graph for the current content.

Returns: The adjacency matrix of the task graph.

Definition at line 332 of file flow.hpp.

◆ operator=() [1/2]

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::operator= ( basic_flow< Allocator > && )

defaultnoexcept

Default move assignment operator.

Returns: This flow builder.

◆ operator=() [2/2]

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::operator= ( const basic_flow< Allocator > & )

default

Default copy assignment operator.

Returns: This flow builder.

◆ operator[]()

template<typename Allocator>

id_type entt::basic_flow< Allocator >::operator[] ( const size_type pos ) const

inlinenodiscard

Returns the identifier at specified location.

Parameters

pos	Position of the identifier to return.

Returns: The requested identifier.

Definition at line 208 of file flow.hpp.

◆ ro() [1/2]

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::ro ( const id_type res )

inline

Assigns a read-only resource to the current task.

Parameters

res	Resource identifier.

Returns: This flow builder.

Definition at line 279 of file flow.hpp.

◆ ro() [2/2]

template<typename Allocator>

template<typename It>

std::enable_if_t< std::is_same_v< std::remove_const_t< typename std::iterator_traits< It >::value_type >, id_type >, basic_flow & > entt::basic_flow< Allocator >::ro	(	It	first,
		It	last )

inline

Assigns a range of read-only resources to the current task.

Template Parameters

It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of elements.
last	An iterator past the last element of the range of elements.

Returns: This flow builder.

Definition at line 293 of file flow.hpp.

◆ rw() [1/2]

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::rw ( const id_type res )

inline

Assigns a writable resource to the current task.

Parameters

res	Resource identifier.

Returns: This flow builder.

Definition at line 306 of file flow.hpp.

◆ rw() [2/2]

template<typename Allocator>

template<typename It>

std::enable_if_t< std::is_same_v< std::remove_const_t< typename std::iterator_traits< It >::value_type >, id_type >, basic_flow & > entt::basic_flow< Allocator >::rw	(	It	first,
		It	last )

inline

Assigns a range of writable resources to the current task.

Template Parameters

It	Type of input iterator.

Parameters

first	An iterator to the first element of the range of elements.
last	An iterator past the last element of the range of elements.

Returns: This flow builder.

Definition at line 320 of file flow.hpp.

◆ set()

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::set	(	const id_type	res,
		bool	is_rw = false )

inline

Assigns a resource to the current task with a given access mode.

Parameters

res	Resource identifier.
is_rw	Access mode.

Returns: This flow builder.

Definition at line 269 of file flow.hpp.

◆ size()

template<typename Allocator>

size_type entt::basic_flow< Allocator >::size ( ) const

inlinenodiscardnoexcept

Returns the number of tasks.

Returns: The number of tasks.

Definition at line 232 of file flow.hpp.

◆ swap()

template<typename Allocator>

void entt::basic_flow< Allocator >::swap ( basic_flow< Allocator > & other )

inlinenoexcept

Exchanges the contents with those of a given flow builder.

Parameters

other Flow builder to exchange the content with.

Definition at line 187 of file flow.hpp.

◆ sync()

template<typename Allocator>

basic_flow & entt::basic_flow< Allocator >::sync ( )

inline

Turns the current task into a sync point.

Returns: This flow builder.

Definition at line 252 of file flow.hpp.

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

src/entt/graph/flow.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ graph_type

◆ iterable

◆ size_type

Constructor & Destructor Documentation

◆ basic_flow() [1/4]

◆ basic_flow() [2/4]

◆ basic_flow() [3/4]

◆ basic_flow() [4/4]

Member Function Documentation

◆ bind()

◆ clear()

◆ empty()

◆ get_allocator()

◆ graph()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]()

◆ ro() [1/2]

◆ ro() [2/2]

◆ rw() [1/2]

◆ rw() [2/2]

◆ set()

◆ size()

◆ swap()

◆ sync()