IMP logo
IMP Reference Guide  develop.cb6747d2d1,2024/03/28
The Integrative Modeling Platform
IMP::kinematics::RRT Class Reference

Simple implementation of the Rapidly-exploring Random Trees algorithm. More...

#include <IMP/kinematics/RRT.h>

+ Inheritance diagram for IMP::kinematics::RRT:

Detailed Description

Simple implementation of the Rapidly-exploring Random Trees algorithm.

Definition at line 29 of file RRT.h.

Classes

class  RRTNode
 Simple RRT node implementation. More...
 

Public Member Functions

 RRT (Model *m, DOFsSampler *sampler, LocalPlanner *planner, const DOFs &cspace_dofs, unsigned int iteration_number=1000, unsigned int tree_size=100, unsigned int number_of_sampled_dofs=0)
 Constructor. More...
 
void check_initial_configuration (ScoringFunction *sf) const
 
IMP::ConfigurationSetdo_sample () const override
 
DOFValuesList get_DOFValuesList ()
 
virtual std::string get_type_name () const override
 
virtual ::IMP::VersionInfo get_version_info () const override
 Get information about the module and version of the object. More...
 
bool run (unsigned int number_of_iterations=0)
 Run the specified number of iterations. More...
 
void set_actual_tree_size (unsigned int num)
 Set the actual tree size - not including path nodes. More...
 
void set_number_of_collisions (unsigned int num)
 Set the number of collisions. More...
 
void set_number_of_iterations (unsigned int num)
 Set number of RRT iterations. More...
 
void set_tree_size (unsigned int num)
 Set tree size. More...
 
- Public Member Functions inherited from IMP::Sampler
 Sampler (Model *m, std::string name="Sampler %1%")
 
ConfigurationSetcreate_sample () const
 
Modelget_model () const
 
ScoringFunctionget_scoring_function () const
 Return the scoring function that is being used. More...
 
void set_scoring_function (ScoringFunctionAdaptor sf)
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 

Friends

std::ostream & operator<< (std::ostream &s, const Parameters &p)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::kinematics::RRT::RRT ( Model m,
DOFsSampler sampler,
LocalPlanner planner,
const DOFs cspace_dofs,
unsigned int  iteration_number = 1000,
unsigned int  tree_size = 100,
unsigned int  number_of_sampled_dofs = 0 
)

Constructor.

Member Function Documentation

virtual ::IMP::VersionInfo IMP::kinematics::RRT::get_version_info ( ) const
overridevirtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 31 of file RRT.h.

bool IMP::kinematics::RRT::run ( unsigned int  number_of_iterations = 0)

Run the specified number of iterations.

If zero, will run for default iteration number.DOFValuesVector This option allows to output the already sampled configurations during the sampling run.

void IMP::kinematics::RRT::set_actual_tree_size ( unsigned int  num)

Set the actual tree size - not including path nodes.

Definition at line 148 of file RRT.h.

void IMP::kinematics::RRT::set_number_of_collisions ( unsigned int  num)

Set the number of collisions.

Definition at line 153 of file RRT.h.

void IMP::kinematics::RRT::set_number_of_iterations ( unsigned int  num)

Set number of RRT iterations.

Definition at line 140 of file RRT.h.

void IMP::kinematics::RRT::set_tree_size ( unsigned int  num)

Set tree size.

Definition at line 145 of file RRT.h.


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