gtopt::DemandProfileLP class
#include <gtopt/demand_profile_lp.hpp>

Base classes

template<typename ProfileType ProfileType, typename ElementLPType ElementLPType>
class ProfileObjectLP<DemandProfile, DemandLP>
Base class for profile-based LP objects.

Public types

using Base = ObjectLP<DemandProfile>
using object_type = ObjectType
Type of the wrapped object.

Public static variables

static constexpr LPClassName ClassName

Constructors, destructors, conversion operators

DemandProfileLP(const DemandProfile& pdemand_profile, InputContext& ic) explicit

Public functions

auto add_profile_to_lp(std::string_view cname, const SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, LinearProblem& lp, std::string_view profile_name, const auto& element_cols, const std::optional<ColIndex>& capacity_col, double stage_capacity) -> bool
Add profile constraints to LP.
auto add_profile_to_output(std::string_view cname, OutputContext& out, std::string_view profile_name) const -> bool
Add profile results to output.
auto add_to_lp(const SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, LinearProblem& lp) -> bool
auto add_to_output(OutputContext& out) const -> bool
auto aperture_value(ScenarioUid scenario_uid, StageUid stage_uid, BlockUid block_uid) const -> std::optional<double>
Return the profile value for a given scenario/stage/block.
template<typename Self Self>
auto class_name(this const Self& self) -> constexpr auto noexcept
auto demand_profile(this auto&& self) -> constexpr auto&& noexcept
auto demand_sid() const -> constexpr auto noexcept
auto id() const -> constexpr auto noexcept
template<typename StageLP StageLP>
auto is_active(const StageLP& stage) const -> constexpr bool
Checks if object is active in given stage.
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto lp_label(this const Self& self, SystemContext& sc, const StageLP& stage, Args && ... args) -> constexpr auto
auto object() && -> constexpr ObjectType&& noexcept
auto object() & -> constexpr ObjectType& noexcept
Gets the wrapped object.
auto object() const && -> constexpr const ObjectType&& noexcept
auto object() const & -> constexpr const ObjectType& noexcept
auto set_id(Uid uid, Name name) -> constexpr auto& noexcept
Sets the object's identifier.
template<typename Self Self>
auto short_name(this const Self& self) -> constexpr auto noexcept
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args) -> constexpr auto
Generates a label for a variable in the optimization problem.
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
auto state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args) -> constexpr auto
template<typename Self Self, typename ScenarioLP ScenarioLP, typename StageLP StageLP>
auto sv_key(this const Self& self, const ScenarioLP& scenario, const StageLP& stage, std::string_view col_name) -> constexpr auto noexcept
Generates a state variable key for the object.
template<typename Self Self, typename StageLP StageLP>
auto sv_key(this const Self& self, const StageLP& stage, std::string_view col_name) -> constexpr auto noexcept
auto uid() const -> constexpr auto noexcept
auto update_aperture(LinearInterface& li, const ScenarioLP& base_scenario, const std::function<std::optional<double>(StageUid, BlockUid)>& value_fn, const StageLP& stage) const -> bool
Update profile constraints for an aperture scenario.

Typedef documentation

using gtopt::DemandProfileLP::Base = ObjectLP<DemandProfile>
#include <gtopt/profile_object_lp.hpp>

using gtopt::DemandProfileLP::object_type = ObjectType
#include <gtopt/object_lp.hpp>

Type of the wrapped object.

Function documentation

bool gtopt::DemandProfileLP::add_profile_to_lp(std::string_view cname, const SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, LinearProblem& lp, std::string_view profile_name, const auto& element_cols, const std::optional<ColIndex>& capacity_col, double stage_capacity)
#include <gtopt/profile_object_lp.hpp>

Add profile constraints to LP.

Parameters
cname Class name prefix for labeling
sc System context
scenario Scenario
stage Stage
lp Linear problem
profile_name Profile type name ("spillover"/"unserved")
element_cols Element column indices per block
capacity_col Capacity column index (if any)
stage_capacity Stage capacity value
Returns true if successful

bool gtopt::DemandProfileLP::add_profile_to_output(std::string_view cname, OutputContext& out, std::string_view profile_name) const
#include <gtopt/profile_object_lp.hpp>

Add profile results to output.

Parameters
cname Class name prefix for labeling
out Output context
profile_name Profile type name ("spillover"/"unserved")
Returns true if successful

std::optional<double> gtopt::DemandProfileLP::aperture_value(ScenarioUid scenario_uid, StageUid stage_uid, BlockUid block_uid) const
#include <gtopt/profile_object_lp.hpp>

Return the profile value for a given scenario/stage/block.

#include <gtopt/object_lp.hpp>
template<typename Self Self>
constexpr auto gtopt::DemandProfileLP::class_name(this const Self& self) noexcept

constexpr auto gtopt::DemandProfileLP::id() const noexcept
#include <gtopt/object_lp.hpp>

Returns The object's complete identifier (uid + name)

#include <gtopt/object_lp.hpp>
template<typename StageLP StageLP>
constexpr bool gtopt::DemandProfileLP::is_active(const StageLP& stage) const

Checks if object is active in given stage.

Parameters
stage The stage to check
Returns true if active in stage, false otherwise

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args)

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::lp_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args)

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args)

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::lp_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args)

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::lp_label(this const Self& self, SystemContext& sc, const StageLP& stage, Args && ... args)

constexpr ObjectType&& gtopt::DemandProfileLP::object() && noexcept
#include <gtopt/object_lp.hpp>

constexpr ObjectType& gtopt::DemandProfileLP::object() & noexcept
#include <gtopt/object_lp.hpp>

Gets the wrapped object.

Returns Reference to the wrapped object

constexpr const ObjectType&& gtopt::DemandProfileLP::object() const && noexcept
#include <gtopt/object_lp.hpp>

constexpr const ObjectType& gtopt::DemandProfileLP::object() const & noexcept
#include <gtopt/object_lp.hpp>

constexpr auto& gtopt::DemandProfileLP::set_id(Uid uid, Name name) noexcept
#include <gtopt/object_lp.hpp>

Sets the object's identifier.

Parameters
uid Unique identifier
name Human-readable name
Returns Reference to self for chaining

#include <gtopt/object_lp.hpp>
template<typename Self Self>
constexpr auto gtopt::DemandProfileLP::short_name(this const Self& self) noexcept

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, Args && ... args)

Generates a label for a variable in the optimization problem.

Parameters
self Reference to the object
sc System context
scenario Scenario context
stage Stage context
args Additional arguments to include in the label
Returns Label string

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename SystemContext SystemContext, typename... Args>
constexpr auto gtopt::DemandProfileLP::state_col_label(this const Self& self, SystemContext& sc, const ScenarioLP& scenario, const StageLP& stage, const BlockLP& block, Args && ... args)

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename ScenarioLP ScenarioLP, typename StageLP StageLP>
constexpr auto gtopt::DemandProfileLP::sv_key(this const Self& self, const ScenarioLP& scenario, const StageLP& stage, std::string_view col_name) noexcept

Generates a state variable key for the object.

Parameters
self Reference to the object
scenario Scenario context
stage Stage context
col_name The column name for the state variable
Returns StateVariable::Key

#include <gtopt/object_utils.hpp>
template<typename Self Self, typename StageLP StageLP>
constexpr auto gtopt::DemandProfileLP::sv_key(this const Self& self, const StageLP& stage, std::string_view col_name) noexcept

constexpr auto gtopt::DemandProfileLP::uid() const noexcept
#include <gtopt/object_lp.hpp>

Returns The object's unique identifier