Struct GenCost 

#[non_exhaustive]
pub struct GenCost {
    pub model: u8,
    pub startup: f64,
    pub shutdown: f64,
    pub ncost: usize,
    pub coeffs: Vec<f64>,
}

A generator cost curve (mpc.gencost row).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model: u8

1 = piecewise linear, 2 = polynomial.

startup: f64

shutdown: f64

ncost: usize

Number of cost coefficients (polynomial) or breakpoints (piecewise).

coeffs: Vec<f64>

Raw coefficients, highest order first for the polynomial model: [c_{k-1}, …, c1, c0].

Implementations

impl GenCost

pub const LEADING_COEFF_TOL: f64 = 1e-12

Largest leading polynomial coefficient that quadratic_with_constant_tol reads as a rounding artifact of the source, not as a term of the curve.

pub fn new(model: u8, startup: f64, shutdown: f64, coeffs: Vec<f64>) -> Self

Build a cost row from the values carried after ncost.

Polynomial rows (model == 2) store ncost coefficients. Piecewise linear rows (model == 1) store flattened (x, y) breakpoint pairs, so ncost is half the coefficient count. Use GenCost::with_ncost for malformed source rows or callers that need to preserve an explicit ncost.

pub fn with_ncost( model: u8, startup: f64, shutdown: f64, ncost: usize, coeffs: Vec<f64>, ) -> Self

pub fn quadratic(&self) -> Option<(f64, f64)>

(q, c) for the quadratic cost ½ q p² + c p from a polynomial (model 2) row. MATPOWER stores c2 p² + c1 p + c0, so q = 2·c2 and c = c1. Linear rows (ncost == 2) give q = 0. Piecewise (model 1) or cubic and higher return None.

pub fn quadratic_with_constant(&self) -> Option<(f64, f64, f64)>

(q, c, c0) for the quadratic cost ½ q p² + c p + c0 from a polynomial (model 2) row, keeping the constant term that quadratic drops. Linear rows (ncost == 2) give q = 0; constant rows (ncost == 1) give q = c = 0. Piecewise (model 1) or cubic and higher return None.

pub fn quadratic_with_constant_tol(&self, tol: f64) -> Option<(f64, f64, f64)>

(q, c, c0) as quadratic_with_constant gives it, after the leading coefficients at or below tol come off the row.

A model 2 row often carries a leading coefficient near 1e-17, which the source produced by rounding. Such a row states a linear curve and reads as a quadratic one. Pass LEADING_COEFF_TOL to strip the artifact, or 0.0 to strip an exact zero alone.

Trait Implementations

impl Clone for GenCost

fn clone(&self) -> GenCost

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GenCost

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenCost

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&GenCost> for SolverCostRow

fn from(cost: &GenCost) -> Self

Converts to this type from the input type.

impl JsonSchema for GenCost

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for GenCost

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.