Struct Curve

pub struct Curve(/* private fields */);

A representation of a piecewise-linear, weakly monotone decreasing demand curve

Demand curves define a bidder’s willingness to pay for different quantities of a good. In flow trading, these curves must be:

• Piecewise-linear (defined by a sequence of points)
• Weakly monotone decreasing (price non-increasing as rate increases)
• Include the point rate=0 in their domain (must allow zero trade)

Implementations

impl Curve

pub fn new(points: Vec<Point>) -> Result<Self, ValidationError>

Creates a new demand curve from a sequence of points

Validates that the points:

• Are not empty
• Have valid (non-NaN, non-infinite) coordinates
• Are ordered by ascending rate and descending price
• Include rate=0 in their domain (first point rate ≤ 0, last point rate ≥ 0)

Returns a ValidationError if any of these conditions are not met.

pub unsafe fn new_unchecked(points: Vec<Point>) -> Self

Creates a new Curve without validating the points

Safety

This function should only be used when the caller can guarantee that the points satisfy all the requirements that new would check. Using invalid points can lead to incorrect behavior in downstream systems.

pub fn into_iter(self) -> impl Iterator<Item = Point>

Converts the curve into an iterator over its points

pub fn scale(&self, x: f64) -> Vec<(f64, f64)>

Scales the rate component of each point by the given factor

Returns a vector of (scaled_rate, price) tuples. This is useful when converting between rate-based and quantity-based representations.

impl Curve

pub fn as_solver(&self, scale: f64) -> PiecewiseLinearCurve

Removes any collinearities and scales by the provided value

This optimizes the curve representation by:

1. Removing intermediate points that lie on the same line segment
2. Scaling rates by the provided factor to convert to quantities

The resulting curve is suitable for use with the solver library.

Trait Implementations

impl Clone for Curve

fn clone(&self) -> Curve

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Curve

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Curve

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Curve

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Into<Vec<Point>> for Curve

fn into(self) -> Vec<Point>

Converts the Curve back into a vector of Points

impl PartialEq for Curve

fn eq(&self, other: &Curve) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Curve

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Curve

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl TryFrom<Vec<Point>> for Curve

fn try_from(value: Vec<Point>) -> Result<Self, Self::Error>

Attempts to create a Curve from a vector of points

Delegates to Curve::new for validation.

type Error = ValidationError

The type returned in the event of a conversion error.

impl StructuralPartialEq for Curve