The abstract class that specifies the structure of a sampler component. More...
#include <base.h>
Public Member Functions | |
| virtual int | sm_update_insert_vertex (vertex_t *vertex_in)=0 |
| Update function for vertex insertion. | |
| virtual int | sm_update_insert_edge (edge_t *edge_in)=0 |
| Update function for edge insertion. | |
| virtual int | sm_update_delete_vertex (vertex_t *vertex_in)=0 |
| Update function for vertex deletion. | |
| virtual int | sm_update_delete_edge (edge_t *edge_in)=0 |
| Update function for edge insertion. | |
| virtual int | sample (state_t **state_sample_out)=0 |
| Provides a sample state from the state space. | |
The abstract class that specifies the structure of a sampler component.
A sampler component provides random or quasi-random samples of states. This abstract class specifies how the sample function should be implemented in any derived class.
| virtual int smp::sampler_base< typeparams >::sample | ( | state_t ** | state_sample_out | ) | [pure virtual] |
Provides a sample state from the state space.
This function creates (by allocating the memory) for a new state that is sampled (randomly or quasi-randomly) from the state space. It returns a pointer to the new state.
| state_sample_out | A pointer to the state that will be returned. This variable can be set to, e.g., the address of a null pointer. |
Implemented in smp::sampler_halton< typeparams, NUM_DIMENSIONS >, smp::sampler_trajectory_bias< typeparams, NUM_DIMENSIONS >, and smp::sampler_uniform< typeparams, NUM_DIMENSIONS >.
| virtual int smp::sampler_base< typeparams >::sm_update_delete_edge | ( | edge_t * | edge_in | ) | [pure virtual] |
Update function for edge insertion.
This function is called by the planner whenever an edge is delete from the graph. A pointer to the edge is given as an argument.
| edge_in | A pointer to deleted edge. |
Implemented in smp::sampler_halton< typeparams, NUM_DIMENSIONS >, smp::sampler_trajectory_bias< typeparams, NUM_DIMENSIONS >, and smp::sampler_uniform< typeparams, NUM_DIMENSIONS >.
| virtual int smp::sampler_base< typeparams >::sm_update_delete_vertex | ( | vertex_t * | vertex_in | ) | [pure virtual] |
Update function for vertex deletion.
This function is called by the planner whenever a vertex is deleted from the graph. A pointer to the vertex is given as an argument.
| vertex_in | A pointer to deleted vertex. |
Implemented in smp::sampler_halton< typeparams, NUM_DIMENSIONS >, smp::sampler_trajectory_bias< typeparams, NUM_DIMENSIONS >, and smp::sampler_uniform< typeparams, NUM_DIMENSIONS >.
| virtual int smp::sampler_base< typeparams >::sm_update_insert_edge | ( | edge_t * | edge_in | ) | [pure virtual] |
Update function for edge insertion.
This function is called by the planner whenever a new edge is added to the graph. A pointer to the new edge is given as an argument.
| edge_in | A pointer to the new edge. |
Implemented in smp::sampler_halton< typeparams, NUM_DIMENSIONS >, smp::sampler_trajectory_bias< typeparams, NUM_DIMENSIONS >, and smp::sampler_uniform< typeparams, NUM_DIMENSIONS >.
| virtual int smp::sampler_base< typeparams >::sm_update_insert_vertex | ( | vertex_t * | vertex_in | ) | [pure virtual] |
Update function for vertex insertion.
This function is called by the planner whenever a new vertex is added to the graph. A pointer to the new vertex is given as an argument.
| vertex_in | A pointer to the new vertex. |
Implemented in smp::sampler_halton< typeparams, NUM_DIMENSIONS >, smp::sampler_trajectory_bias< typeparams, NUM_DIMENSIONS >, and smp::sampler_uniform< typeparams, NUM_DIMENSIONS >.
