Skip to main content

ParametricPolytope

Struct ParametricPolytope 

Source
pub struct ParametricPolytope { /* private fields */ }
Expand description

A family of polytopes {x : hₖ(j, x) ≥ 0} whose half-spaces are affine in x with coefficients polynomial in one parameter j.

at instantiates the family exactly at a rational j; polytope_at / vertices_at / volume_at do the same with a per-value cache, for tree builders that revisit the same samples.

use symplex::prelude::*;
use symplex::polytope::ParametricPolytope;
use symplex::linprog::{q, qi};

let ctx = Context::new();
let (j, r, t) = (ctx.symbol("j"), ctx.symbol("r"), ctx.symbol("t"));
// 0 ≤ r ≤ 1/2, 0 ≤ t ≤ 1, (2j + 1)·t ≥ j·r + 1
let hyps = [r.clone(), ctx.rational(1, 2) - &r, t.clone(), 1 - &t, (&j * 2 + 1) * &t - &j * &r - 1];
let mut cell = ParametricPolytope::new(&hyps, &[r, t], &j).unwrap();
assert_eq!(cell.volume_at(&qi(2)).unwrap(), q(7, 20));   // ∫₀^{1/2} (1 − (2r + 1)/5) dr
assert_eq!(cell.vertices_at(&qi(2)).unwrap().len(), 4);
assert!(cell.at(&qi(100)).unwrap().contains(&[q(1, 4), q(3, 4)]));

Implementations§

Source§

impl ParametricPolytope

Source

pub fn new(hyps: &[Ex], vars: &[Ex], param: &Ex) -> Result<Self, SymplexError>

Build from hypotheses hₖ(j, x) ≥ 0, each affine in vars with coefficients polynomial (rational) in param.

§Errors

SymplexError::InvalidArgument if a hypothesis is not a polynomial in the variables and the parameter, is not affine in the variables, or has a symbolic coefficient; or if the lists are empty.

Source

pub fn vars(&self) -> &[Ex]

The variables, in order.

Source

pub fn param(&self) -> &Ex

The parameter.

Source

pub fn hyps(&self) -> &[Poly]

The hypotheses as polynomials in (vars…, param).

Source

pub fn at(&self, value: &Q) -> Result<Polytope, SymplexError>

The polytope at param = value, exactly (no cache). Pure rational arithmetic on the stored polynomials — no expression arena is touched, so sampling a family densely is cheap.

§Errors

Only internal failures (the substitution of a rational is always affine in the variables).

Source

pub fn polytope_at(&mut self, value: &Q) -> Result<&Polytope, SymplexError>

The polytope at param = value, cached.

§Errors

As at.

Source

pub fn vertices_at(&mut self, value: &Q) -> Result<&[Vec<Q>], SymplexError>

The vertices at param = value, cached.

§Errors

As at.

Source

pub fn volume_at(&mut self, value: &Q) -> Result<Q, SymplexError>

The volume at param = value (uses the cached polytope).

§Errors

As Polytope::volume.

Source

pub fn is_empty_at(&mut self, value: &Q) -> Result<bool, SymplexError>

Is the polytope at param = value empty?

§Errors

As Polytope::is_empty.

Source

pub fn contains_at(&mut self, value: &Q, x: &[Q]) -> Result<bool, SymplexError>

Does the polytope at param = value contain x?

§Errors

As at.

Source

pub fn clear_cache(&mut self)

Forget every cached instantiation.

Trait Implementations§

Source§

impl Clone for ParametricPolytope

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParametricPolytope

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more