GEDLIB  1.0
Private Member Functions | List of all members
ged::BPBeam< UserNodeLabel, UserEdgeLabel > Class Template Reference

Computes an upper bound for general edit costs. More...

#include <bp_beam.hpp>

Inheritance diagram for ged::BPBeam< UserNodeLabel, UserEdgeLabel >:
Inheritance graph
[legend]

Private Member Functions

virtual void ls_run_from_initial_solution_ (const GEDGraph &g, const GEDGraph &h, double lower_bound, const NodeMap &initial_node_map, NodeMap &output_node_map) final
 Runs the local search from an initial node map. More...
 
virtual void ls_set_default_options_ () final
 Sets all options that are not among the ones shared by all derived classes of ged::LSBasedMethod to default values. More...
 
virtual bool ls_parse_option_ (const std::string &option, const std::string &arg) final
 Parses one option that is not among the ones shared by all derived classes of ged::LSBasedMethod. More...
 
virtual std::string ls_valid_options_string_ () const final
 Returns string of all valid options that are not among the ones shared by all derived classes of ged::LSBasedMethod. More...
 

Additional Inherited Members

- Public Member Functions inherited from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >
virtual ~LSBasedMethod ()=0
 Pure virtual destructor. More...
 
 LSBasedMethod (const GEDData< UserNodeLabel, UserEdgeLabel > &ged_data)
 Constructor. More...
 
- Public Member Functions inherited from ged::GEDMethod< UserNodeLabel, UserEdgeLabel >
virtual ~GEDMethod ()=0
 Pure virtual destructor. More...
 
 GEDMethod (const GEDData< UserNodeLabel, UserEdgeLabel > &ged_data)
 Constructor. More...
 
void set_options (const std::string &options)
 Sets the options of the method. More...
 
void run (GEDGraph::GraphID g_id, GEDGraph::GraphID h_id)
 Runs the method with options specified by set_options(). More...
 
void run_as_util (const GEDGraph &g, const GEDGraph &h, Result &result)
 Runs the method with options specified by set_options(). More...
 
void init ()
 Initializes the method with options specified by set_options().
 
double get_upper_bound () const
 Returns an upper bound. More...
 
double get_lower_bound () const
 Returns a lower bound. More...
 
Seconds get_runtime () const
 Returns the runtime. More...
 
Seconds get_init_time () const
 Returns the initialization time. More...
 
const NodeMapget_node_map () const
 Returns a graph matching. More...
 
- Protected Attributes inherited from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >
std::size_t num_threads_
 The number of threads to be used.
 
- Protected Attributes inherited from ged::GEDMethod< UserNodeLabel, UserEdgeLabel >
bool initialized_
 A flag that equals true if init() has been called and false otherwise.
 
const GEDData< UserNodeLabel, UserEdgeLabel > & ged_data_
 The data on which the method is run.
 

Detailed Description

template<class UserNodeLabel, class UserEdgeLabel>
class ged::BPBeam< UserNodeLabel, UserEdgeLabel >

Computes an upper bound for general edit costs.

Implements the methods BP-Beam suggested in:

the extension IBP-Beam suggested in:

Supports the following options in addition to the ones supported by ged::LSBasedMethod:

--<option> <arg> modified parameter default more information
--beam-size <convertible to int greater 0> the size of the priority queue used by the beam search 5 https://doi.org/10.1007/978-3-319-11656-3_11
--num-orderings <convertible to int greater 0> the number of orderings 1 https://doi.org/10.1007/978-3-319-18224-7_8
if greater 1, IBP-Beam is used

Definition at line 52 of file bp_beam.hpp.

Member Function Documentation

◆ ls_parse_option_()

template<class UserNodeLabel , class UserEdgeLabel >
bool ged::BPBeam< UserNodeLabel, UserEdgeLabel >::ls_parse_option_ ( const std::string &  option,
const std::string &  arg 
)
finalprivatevirtual

Parses one option that is not among the ones shared by all derived classes of ged::LSBasedMethod.

Parameters
[in]optionThe name of the option.
[in]argThe argument of the option.
Returns
Returns true if option is a valid option name for the method and false otherwise.
Note
Must be overridden by derived classes of ged::LSBasedMethod that have options that are not among the ones shared by all derived classes of ged::LSBasedMethod.

Reimplemented from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >.

Definition at line 105 of file bp_beam.ipp.

◆ ls_run_from_initial_solution_()

template<class UserNodeLabel , class UserEdgeLabel >
void ged::BPBeam< UserNodeLabel, UserEdgeLabel >::ls_run_from_initial_solution_ ( const GEDGraph g,
const GEDGraph h,
double  lower_bound,
const NodeMap initial_node_map,
NodeMap output_node_map 
)
finalprivatevirtual

Runs the local search from an initial node map.

Parameters
[in]gInput graph.
[in]hInput graph.
[in]lower_boundA lower bound for GED which can be used as a termination criterion.
[in]initial_node_mapInitial node map.
[out]output_node_mapNode map constructed by local search.
Note
Must be overridden by derived classes of ged::LSBasedMethod.

Reimplemented from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >.

Definition at line 48 of file bp_beam.ipp.

◆ ls_set_default_options_()

template<class UserNodeLabel , class UserEdgeLabel >
void ged::BPBeam< UserNodeLabel, UserEdgeLabel >::ls_set_default_options_ ( )
finalprivatevirtual

Sets all options that are not among the ones shared by all derived classes of ged::LSBasedMethod to default values.

Note
Must be overridden by derived classes of ged::LSBasedMethod that have options that are not among the ones shared by all derived classes of ged::LSBasedMethod.

Reimplemented from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >.

Definition at line 97 of file bp_beam.ipp.

◆ ls_valid_options_string_()

template<class UserNodeLabel , class UserEdgeLabel >
std::string ged::BPBeam< UserNodeLabel, UserEdgeLabel >::ls_valid_options_string_ ( ) const
finalprivatevirtual

Returns string of all valid options that are not among the ones shared by all derived classes of ged::LSBasedMethod.

Returns
String of the form "[--<option> <arg>] [...]".
Note
Must be overridden by derived classes of ged::LSBasedMethod that have options that are not among the ones shared by all derived classes of ged::LSBasedMethod.

Reimplemented from ged::LSBasedMethod< UserNodeLabel, UserEdgeLabel >.

Definition at line 138 of file bp_beam.ipp.


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