Struct Picheny 

pub struct Picheny<P = Vec<f64>>(/* private fields */);

Available on crate feature problems only.

Pre-wrapped Picheny problem (fixed 2D). Generic over the parameter backend P; the default P = Vec<f64> lets you write Picheny::default() for the common case. Backend impls (nalgebra::DVector<f64>, ndarray::Array1<f64>, faer::Col<f64>) are gated behind their respective features.

Implementations

impl<P> Picheny<P>

pub const fn new() -> Self

Build a freshly typed problem instance. Pair with one of the backend-specific impl blocks (Vec, nalgebra, ndarray, faer).

Trait Implementations

impl CostFunction for Picheny<Vec<f64>>

type Param = Vec<f64>

The parameter type the objective is defined over.

type Output = f64

Scalar cost type. In practice f64 (see CONTRIBUTING.md’s provisional choices).

type Error = Infallible

User-chosen hard-abort error. Pick std::convert::Infallible when the cost cannot fail: its niche optimization keeps Result<f64, Infallible> the same layout as bare f64 on the happy path.

fn cost(&self, x: &Vec<f64>) -> Result<f64, Infallible>

Evaluate the objective at param.

impl CostFunction for Picheny<DVector<f64>>

Available on crate feature nalgebra only.

type Param = Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

The parameter type the objective is defined over.

type Output = f64

Scalar cost type. In practice f64 (see CONTRIBUTING.md’s provisional choices).

type Error = Infallible

User-chosen hard-abort error. Pick std::convert::Infallible when the cost cannot fail: its niche optimization keeps Result<f64, Infallible> the same layout as bare f64 on the happy path.

fn cost(&self, x: &DVector<f64>) -> Result<f64, Infallible>

Evaluate the objective at param.

impl CostFunction for Picheny<Array1<f64>>

Available on crate feature ndarray only.

type Param = ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>

The parameter type the objective is defined over.

type Output = f64

Scalar cost type. In practice f64 (see CONTRIBUTING.md’s provisional choices).

type Error = Infallible

User-chosen hard-abort error. Pick std::convert::Infallible when the cost cannot fail: its niche optimization keeps Result<f64, Infallible> the same layout as bare f64 on the happy path.

fn cost(&self, x: &Array1<f64>) -> Result<f64, Infallible>

Evaluate the objective at param.

impl CostFunction for Picheny<Col<f64>>

Available on crate feature faer only.

type Param = Col<Own<f64>>

The parameter type the objective is defined over.

type Output = f64

Scalar cost type. In practice f64 (see CONTRIBUTING.md’s provisional choices).

type Error = Infallible

User-chosen hard-abort error. Pick std::convert::Infallible when the cost cannot fail: its niche optimization keeps Result<f64, Infallible> the same layout as bare f64 on the happy path.

fn cost(&self, x: &Col<f64>) -> Result<f64, Infallible>

Evaluate the objective at param.

impl<P> Default for Picheny<P>

fn default() -> Self

Returns the “default value” for a type.

impl Gradient for Picheny<Vec<f64>>

type Gradient = Vec<f64>

The gradient type. Typically the same as CostFunction::Param.

fn gradient(&self, x: &Vec<f64>) -> Result<Vec<f64>, Infallible>

Evaluate the gradient at param.

fn cost_and_gradient( &self, param: &Self::Param, ) -> Result<(Self::Output, Self::Gradient), Self::Error>

Evaluate cost and gradient at param in one call. The default body delegates to CostFunction::cost and Gradient::gradient; override when shared intermediate work can be amortized across the two.

impl Gradient for Picheny<DVector<f64>>

Available on crate feature nalgebra only.

type Gradient = Matrix<f64, Dyn, Const<1>, VecStorage<f64, Dyn, Const<1>>>

The gradient type. Typically the same as CostFunction::Param.

fn gradient(&self, x: &DVector<f64>) -> Result<DVector<f64>, Infallible>

Evaluate the gradient at param.

fn cost_and_gradient( &self, param: &Self::Param, ) -> Result<(Self::Output, Self::Gradient), Self::Error>

Evaluate cost and gradient at param in one call. The default body delegates to CostFunction::cost and Gradient::gradient; override when shared intermediate work can be amortized across the two.

impl Gradient for Picheny<Array1<f64>>

Available on crate feature ndarray only.

type Gradient = ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>

The gradient type. Typically the same as CostFunction::Param.

fn gradient(&self, x: &Array1<f64>) -> Result<Array1<f64>, Infallible>

Evaluate the gradient at param.

fn cost_and_gradient( &self, param: &Self::Param, ) -> Result<(Self::Output, Self::Gradient), Self::Error>

Evaluate cost and gradient at param in one call. The default body delegates to CostFunction::cost and Gradient::gradient; override when shared intermediate work can be amortized across the two.

impl Gradient for Picheny<Col<f64>>

Available on crate feature faer only.

type Gradient = Col<Own<f64>>

The gradient type. Typically the same as CostFunction::Param.

fn gradient(&self, x: &Col<f64>) -> Result<Col<f64>, Infallible>

Evaluate the gradient at param.

fn cost_and_gradient( &self, param: &Self::Param, ) -> Result<(Self::Output, Self::Gradient), Self::Error>

Evaluate cost and gradient at param in one call. The default body delegates to CostFunction::cost and Gradient::gradient; override when shared intermediate work can be amortized across the two.

impl<P> HasSpec for Picheny<P>

const SPEC: &'static ProblemSpec

The catalog entry for this problem type.