Ignition Math

API Reference

6.9.3~pre2
EdgeInitializer< E > Struct Template Reference

Used in the Graph constructors for uniform initialization. More...

#include <Edge.hh>

Public Member Functions

 EdgeInitializer (const VertexId_P &_vertices, const E &_data=E(), const double _weight=1)
 Constructor. More...
 

Public Attributes

data
 User data. More...
 
VertexId_P vertices
 IDs of the vertices. More...
 
double weight = 1
 The weight (cost) of the edge. More...
 

Detailed Description

template<typename E>
struct ignition::math::graph::EdgeInitializer< E >

Used in the Graph constructors for uniform initialization.

Constructor & Destructor Documentation

◆ EdgeInitializer()

EdgeInitializer ( const VertexId_P _vertices,
const E &  _data = E(),
const double  _weight = 1 
)
inline

Constructor.

Parameters
[in]_verticesThe vertices of the edge.
[in]_dataThe data stored in the edge.
[in]_weightThe weight (cost) of the edge.

Member Data Documentation

◆ data

E data

User data.

Referenced by Edge< E >::Data(), and Edge< E >::Valid().

◆ vertices

VertexId_P vertices

IDs of the vertices.

Referenced by Edge< E >::Valid(), and Edge< E >::Vertices().

◆ weight

double weight = 1

The weight (cost) of the edge.

Referenced by Edge< E >::SetWeight(), Edge< E >::Valid(), and Edge< E >::Weight().


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