Enum varpro::model::builder::error::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 {
        params: Vec<String>,
        string_params_count: usize,
        function_argument_count: usize,
    },
    CommaInParameterNameNotAllowed {
        param_name: String,
    },
}

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

Variants

DuplicateParameterNames

Model or function parameters contain duplicates

Fields of DuplicateParameterNames

function_parameters: Vec<String>

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 of FunctionParameterNotInModel

function_parameter: String

InvalidDerivative

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

Fields of InvalidDerivative

parameter: Stringfunction_parameters: Vec<String>

DuplicateDerivative

Tried to provide the same partial derivative twice.

Fields of DuplicateDerivative

parameter: String

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 of MissingDerivative

missing_parameter: Stringfunction_parameters: Vec<String>

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 of UnusedParameter

parameter: String

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 of IncorrectParameterCount

params: Vec<String>string_params_count: usizefunction_argument_count: usize

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 of CommaInParameterNameNotAllowed

param_name: String

Trait Implementations

impl Clone for ModelBuildError

fn clone(&self) -> ModelBuildError

Returns a copy of the value.

pub 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, __snafu_display_formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ModelBuildError where
    Self: Debug + Display, 

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 source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

impl ErrorCompat for ModelBuildError

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.

impl<ScalarType> From<ModelBuildError> for SeparableModelBuilder<ScalarType> where
    ScalarType: Scalar, 

create a SeparableModelBuilder which contains an error variant

fn from(err: ModelBuildError) -> Self

Performs the conversion.

impl<ScalarType> From<ModelBuildError> for SeparableModelBuilderProxyWithDerivatives<ScalarType> where
    ScalarType: Scalar, 

fn from(err: ModelBuildError) -> Self

Performs the conversion.

impl<__T0> IntoError<ModelBuildError> for DuplicateParameterNames<__T0> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<Vec<String>>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl IntoError<ModelBuildError> for EmptyParameters where
    ModelBuildError: Error + ErrorCompat, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0> IntoError<ModelBuildError> for FunctionParameterNotInModel<__T0> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0, __T1> IntoError<ModelBuildError> for InvalidDerivative<__T0, __T1> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>,
    __T1: Into<Vec<String>>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0> IntoError<ModelBuildError> for DuplicateDerivative<__T0> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0, __T1> IntoError<ModelBuildError> for MissingDerivative<__T0, __T1> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>,
    __T1: Into<Vec<String>>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl IntoError<ModelBuildError> for EmptyModel where
    ModelBuildError: Error + ErrorCompat, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0> IntoError<ModelBuildError> for UnusedParameter<__T0> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0, __T1, __T2> IntoError<ModelBuildError> for IncorrectParameterCount<__T0, __T1, __T2> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<Vec<String>>,
    __T1: Into<usize>,
    __T2: Into<usize>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl<__T0> IntoError<ModelBuildError> for CommaInParameterNameNotAllowed<__T0> where
    ModelBuildError: Error + ErrorCompat,
    __T0: Into<String>, 

type Source = NoneError

The underlying error

fn into_error(self, error: Self::Source) -> ModelBuildError

Combine the information to produce the error

impl PartialEq<ModelBuildError> for ModelBuildError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ModelBuildError