Enum ModelBuildError

pub enum ModelBuildError {
    DuplicateParameterNames {
        function_parameters: Vec<String>,
    },
    EmptyParameters,
    FunctionParameterNotInModel {
        function_parameter: String,
    },
    InvalidDerivative {
        parameter: String,
        function_parameters: Vec<String>,
    },
    DuplicateDerivative {
        parameter: String,
    },
    MissingDerivative {
        missing_parameter: String,
        function_parameters: Vec<String>,
    },
    EmptyModel,
    UnusedParameter {
        parameter: String,
    },
    IncorrectParameterCount {
        actual: usize,
        expected: usize,
    },
    CommaInParameterNameNotAllowed {
        param_name: String,
    },
    MissingX,
    MissingInitialParameters,
    IllegalCallToPartialDeriv,
}

An error structure that contains error variants that occur when building a model.

Variants

DuplicateParameterNames

Model or function parameters contain duplicates

Fields

function_parameters: Vec<String>

the given parameter list containing duplicates

EmptyParameters

Model or function parameter list is empty. To add functions that are independent of model parameters, use the interface for adding invariant functions.

FunctionParameterNotInModel

A function was added to the model which depends on parameters which are not in the model

Fields

function_parameter: String

the name of the parameter not in the set

InvalidDerivative

Tried to provide a partial derivative with respect to a parameter that a function does not depend on

Fields

parameter: String

paramter where a derivative was provided

function_parameters: Vec<String>

the actual parameters this function depends on

DuplicateDerivative

Tried to provide the same partial derivative twice.

Fields

parameter: String

the name of the derivative specified twice

MissingDerivative

Not all partial derivatives for a function where given. Each function must be given a partial derivative with respect to each parameter it depends on.

Fields

missing_parameter: String

this parameter misses a derivative

function_parameters: Vec<String>

the parameters that this function depends on

EmptyModel

Tried to construct a model without base functions

UnusedParameter

The model depends on a certain parameter that none of the base functions depend on.

Fields

parameter: String

the unused parameter name

IncorrectParameterCount

This error indicates that the more or fewer string parameters where provided as function parameters than the actual variadic function takes. This might accidentally happen when giving a derivative that does not depend on a certain parameter, whereas the base function does. However, the library requires that the derivatives take all the parameters its base function takes in the same order.

Fields

actual: usize

the actual number of arguments

expected: usize

the number of

CommaInParameterNameNotAllowed

Parameter names may not contain a comma separator, because this is most likely caused by a typo, i.e. ["tau,phi"], instead of actually ["tau","phi"]. So this is forbidden in order to help spotting these hard to find errors.

Fields

param_name: String

the parameter name

MissingX

x-vector (independent variable) was not supplied to the model builder

MissingInitialParameters

missing initial guesses for parameters

IllegalCallToPartialDeriv

an illegal call to the partial_deriv function

Trait Implementations

impl Clone for ModelBuildError

fn clone(&self) -> ModelBuildError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelBuildError

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

Formats the value using the given formatter.

impl Display for ModelBuildError

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

Formats the value using the given formatter.

impl Error for ModelBuildError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<ScalarType> From<ModelBuildError> for SeparableModelBuilder<ScalarType>

where ScalarType: Scalar,

create a SeparableModelBuilder which contains an error variant

fn from(err: ModelBuildError) -> Self

Converts to this type from the input type.

impl PartialEq for ModelBuildError

fn eq(&self, other: &ModelBuildError) -> 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 Eq for ModelBuildError

impl StructuralPartialEq for ModelBuildError