API Reference#
C++ API (Doxygen)#
We generate C++ API docs with Doxygen and expose them in Sphinx via Breathe.
Note
Run Doxygen first, then build Sphinx:
cd docs
# 1) Run doxygen
# doxygen Doxyfile
# 2) Build Sphinx
# make html
- C++ API
routing::attributes::Appointmentrouting::Attributerouting::mip::BoolVarrouting::constraints::CapacityConstraintGeneratorrouting::evaluators::CapacityEvaluatorrouting::plugins::CapacityPluginrouting::ChromosomeCmprouting::Clientrouting::models::Clientrouting::plugins::ComposableCorePluginrouting::Configurationrouting::ConstraintConfigrouting::ConstructionParametersrouting::Constructorrouting::attributes::Consumerrouting::cp::generators::CPCapacityGeneratorrouting::GeneratorRegistry::CPEntryrouting::PluginRegistry::CPGeneratorEntryrouting::mip::CPLEXMIPBackendrouting::cp::CPOptimizerBackendrouting::cp::generators::CPRoutingGeneratorrouting::cp::CPSolverrouting::plugins::CPSolverPluginrouting::cp::generators::CPTimeWindowGeneratorrouting::Decoderrouting::DefaultInitializerrouting::attributes::Deliveryrouting::Depotrouting::models::Depotrouting::DestructionParametersrouting::Destructorrouting::Diverrouting::dummyDecoderrouting::dummyDiverrouting::Entityrouting::EntityDatarouting::GASolverrouting::plugins::GASolverPluginrouting::plugins::GASolverWrapperrouting::Generatorrouting::GeneratorRegistryrouting::attributes::GeoNoderouting::GreedyConstructorrouting::callback::HeuristicCallbackrouting::mip::HiGHSMIPBackendrouting::IAttributerouting::IConstraintGeneratorrouting::cp::ICPBackendrouting::cp::ICPConstraintGeneratorrouting::IDCHrouting::plugins::IDCHNeighborhoodrouting::plugins::IDCHPluginrouting::IEntityDatarouting::IEvaluatorrouting::mip::IMIPBackendrouting::mip::IMIPConstraintGeneratorrouting::callback::IncumbentCallbackrouting::INeighborhoodrouting::callback::InformationCallbackrouting::Initializerrouting::InsertionContextrouting::InsertionCostrouting::cp::IntervalVarrouting::cp::IntVarrouting::mip::IntVarrouting::IPluginrouting::IReaderrouting::ISolutionValuerouting::ISolverrouting::callback::LazyConstraintCallbackrouting::cp::LinearExprrouting::mip::LinearExprrouting::LSSolverrouting::plugins::LSSolverPluginrouting::plugins::LSSolverWrapperrouting::MASolverrouting::plugins::MASolverPluginrouting::plugins::MASolverWrapperrouting::Memoryrouting::mip::generators::MIPCapacityGeneratorrouting::GeneratorRegistry::MIPEntryrouting::PluginRegistry::MIPGeneratorEntryrouting::mip::generators::MIPRoutingGeneratorrouting::MIPSolverrouting::plugins::MIPSolverPluginrouting::mip::generators::MIPTimeWindowGeneratorrouting::Modelrouting::Moverouting::Neighborhoodrouting::NeighborhoodMoverouting::cp::OptionalIntervalVarrouting::cp::ORToolsCPSATBackendrouting::ParameterNotFoundrouting::Particlerouting::attributes::Pickuprouting::constraints::PickupDeliveryConstraintGeneratorrouting::plugins::PickupDeliveryPluginrouting::PluginRegistrarrouting::PluginRegistryrouting::Populationrouting::Problemrouting::attributes::Profiterrouting::constraints::ProfitObjectiveGeneratorrouting::plugins::ProfitPluginrouting::PSOKeyrouting::PSOSolverrouting::plugins::PSOSolverPluginrouting::plugins::PSOSolverWrapperrouting::mip::QuadExprrouting::RandomDestructorrouting::Readerrouting::RemoveCostrouting::attributes::Rendezvousrouting::constraints::RoutingConstraintGeneratorrouting::evaluators::RoutingEvaluatorrouting::plugins::RoutingPluginrouting::Sequencerouting::attributes::Servicerouting::attributes::ServiceQueryrouting::constraints::SoftTimeWindowGeneratorrouting::attributes::SoftTimeWindowsrouting::plugins::SolomonReaderrouting::plugins::SolomonReaderPluginrouting::Solutionrouting::SolutionValuerouting::Solverrouting::attributes::Stockrouting::constraints::SyncConstraintGeneratorrouting::attributes::Syncedrouting::plugins::SyncPluginrouting::attributes::Synced::SyncRelationrouting::constraints::TimeWindowConstraintGeneratorrouting::evaluators::TimeWindowEvaluatorrouting::plugins::TimeWindowPluginrouting::models::Tourrouting::Tourrouting::plugins::TSPLIBReaderrouting::plugins::TSPLIBReaderPluginrouting::TwoOptrouting::TwoOptMovementrouting::plugins::TwoOptNeighborhoodrouting::plugins::TwoOptPluginrouting::callback::UserCutCallbackrouting::mip::Varrouting::models::Vehiclerouting::Vehiclerouting::VNSSolverrouting::plugins::VNSSolverPluginrouting::plugins::VNSSolverWrapperrouting::cp::XCSP3Backendrouting::cp::XCSP3Intervalrouting::cp::XCSP3Solverrouting::plugins::XCSP3SolverPluginrouting::cp::XCSP3VariableIloCplexroutingrouting::attributesrouting::callbackrouting::constraintsrouting::cprouting::cp::generatorsrouting::evaluatorsrouting::miprouting::mip::generatorsrouting::modelsrouting::pluginsrouting::plugins::solomon_detailrouting::plugins::tsplib_detailstdROUTING_REGISTER_CP_GENERATORROUTING_REGISTER_MIP_GENERATORROUTING_REGISTER_PLUGIN
Python API#
The Python bindings live under python/routing/ and are exposed via the
routing package.