numerical-collection-cpp 0.10.0
A collection of algorithms in numerical analysis implemented in C++
Loading...
Searching...
No Matches
num_collect::auto_diff::backward::graph::node< Scalar > Class Template Reference

Class of nodes in graphs of automatic differentiation. More...

#include <num_collect/auto_diff/backward/graph/node.h>

+ Collaboration diagram for num_collect::auto_diff::backward::graph::node< Scalar >:

Public Types

using scalar_type = Scalar
 Type of scalars.
 

Public Member Functions

 node (std::vector< child_node< scalar_type > > children=std::vector< child_node< scalar_type > >())
 Constructor.
 
auto children () const noexcept -> const std::vector< child_node< scalar_type > > &
 Get the child nodes.
 

Private Attributes

std::vector< child_node< scalar_type > > children_
 Child nodes.
 

Detailed Description

template<base::concepts::real_scalar Scalar>
class num_collect::auto_diff::backward::graph::node< Scalar >

Class of nodes in graphs of automatic differentiation.

Template Parameters
ScalarType of scalars.

Definition at line 99 of file node.h.

Member Typedef Documentation

◆ scalar_type

template<base::concepts::real_scalar Scalar>
using num_collect::auto_diff::backward::graph::node< Scalar >::scalar_type = Scalar

Type of scalars.

Definition at line 102 of file node.h.

Constructor & Destructor Documentation

◆ node()

template<base::concepts::real_scalar Scalar>
num_collect::auto_diff::backward::graph::node< Scalar >::node ( std::vector< child_node< scalar_type > > children = std::vector<child_node<scalar_type>>())
inlineexplicit

Constructor.

Parameters
[in]childrenChild nodes.

Definition at line 109 of file node.h.

Member Function Documentation

◆ children()

template<base::concepts::real_scalar Scalar>
auto num_collect::auto_diff::backward::graph::node< Scalar >::children ( ) const -> const std::vector<child_node<scalar_type>>&
inlinenodiscardnoexcept

Get the child nodes.

Returns
Child nodes.

Definition at line 118 of file node.h.

Member Data Documentation

◆ children_

template<base::concepts::real_scalar Scalar>
std::vector<child_node<scalar_type> > num_collect::auto_diff::backward::graph::node< Scalar >::children_
private

Child nodes.

Definition at line 125 of file node.h.


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