Struct InstantiationResult 

pub struct InstantiationResult<C: ComplexScalar> {
    pub params: Option<Vec<C::R>>,
    pub fun: Option<C::R>,
    pub status: usize,
    pub message: Option<String>,
}

Result of an instantiation operation.

This struct encapsulates the outcome of an instantiation attempt. It provides information about the success/failure status, and other relevant information. Very little is standardized between instantiaters, so refer to specific instantiaters for more documentation on how the fields are used.

A successful instantiation is one that was able to run until

Status Codes

• 0 - Successful termination
• 1 - Input cannot be handled by instantiator
• 2+ - Instantiator-specific error codes (see relevant documentation)

Fields

params: Option<Vec<C::R>>

The instantiated solution’s parameters.

fun: Option<C::R>

Optional function evaluation at the solution point.

If provided, represents instantiation-specific objective function value at the computed solution. Useful for assessing solution quality. Consult with instantiater documentation.

status: usize

Termination status code.

• 0: Successful termination
• 1: Input cannot be handled by instantiator; see message
• 2+: Instantiator-specific error codes; see relevant documentation

message: Option<String>

Optional diagnostic message, providing additional context.

Implementations

impl<C: ComplexScalar> InstantiationResult<C>

pub fn new( params: Option<Vec<C::R>>, fun: Option<C::R>, status: usize, message: Option<String>, ) -> Self

Creates a new InstantiationResult with all fields specified.

Arguments

• params - Optional solution parameters
• fun - Optional function evaluation
• status - Status code (0 for success)
• message - Optional diagnostic message

Examples

let result = InstantiationResult::<c64>::new(
    Some(vec![1.0, 2.0]),
    Some(0.1),
    0,
    Some("Converged successfully".to_string())
);

pub fn success(params: Vec<C::R>, fun: Option<C::R>) -> Self

Creates a successful instantiation result.

Arguments

• params - The computed solution parameters
• fun - Optional function evaluation

Examples

let result = InstantiationResult::<c64>::success(
    vec![0.5, 1.0, 1.5],
    Some(0.0001)
);
assert!(result.is_success());

pub fn success_with_message( params: Vec<C::R>, fun: Option<C::R>, message: String, ) -> Self

Creates a successful instantiation result with a message.

Arguments

• params - The computed solution parameters
• fun - Optional function evaluation
• message - Success message

pub fn is_success(&self) -> bool

Returns true if the instantiation was successful (status == 0).

Examples

let success = InstantiationResult::<c64>::success(vec![1.0], None);
assert!(success.is_success());

pub fn is_failure(&self) -> bool

Returns true if the instantiation failed (status > 0).

pub fn has_params(&self) -> bool

Returns true if the result contains solution parameters.

pub fn has_function_value(&self) -> bool

Returns true if the result contains a function evaluation.

pub fn num_params(&self) -> Option<usize>

Returns the number of parameters if available.

Trait Implementations

impl<C: Clone + ComplexScalar> Clone for InstantiationResult<C>

where C::R: Clone,

fn clone(&self) -> InstantiationResult<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + ComplexScalar> Debug for InstantiationResult<C>

where C::R: Debug,

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

Formats the value using the given formatter.

impl<C: ComplexScalar> Display for InstantiationResult<C>

where C::R: Display,

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

Formats the value using the given formatter.

impl<C: PartialEq + ComplexScalar> PartialEq for InstantiationResult<C>

where C::R: PartialEq,

fn eq(&self, other: &InstantiationResult<C>) -> 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<C: ComplexScalar> StructuralPartialEq for InstantiationResult<C>