Trait Arithmetic 

pub trait Arithmetic<Input> {
    type Error;

    // Required methods
    fn merge(
        geometries: &[&Input],
        operation: MergeOperation,
    ) -> Result<Input, Self::Error>;
    fn merge_with(
        &self,
        other: &Input,
        operation: MergeOperation,
    ) -> Result<Input, Self::Error>;
}

A trait that provides arithmetic operations for working with geometries, enabling merging and combining of curve data based on different operations.

This trait allows performing mathematical operations between geometric objects, particularly curves, to create new derived geometries. It supports various operations like addition, subtraction, multiplication, and more through the MergeOperation enum.

Type Parameters

• Input: The type of geometric object that can be merged and operated upon.

Associated Types

• Error: Represents the type of error that may occur during curve operations.

Required Methods

merge

Combines multiple geometries into a single curve based on a specified MergeOperation.

Parameters

• geometries: A slice of references to the input geometries that need to be merged.
• operation: The operation used to combine the geometries (e.g., addition, subtraction, etc.).

Returns

• Result<Input, Self::Error>: Returns the resulting merged curve if successful, or an error of type Self::Error if the merge process fails.

merge_with

Merges the current curve with another curve based on a specified MergeOperation.

Parameters

• other: A reference to another curve to be merged.
• operation: The operation used to combine the geometries (e.g., addition, subtraction, etc.).

Returns

• Result<Input, Self::Error>: Returns the resulting merged curve if successful, or an error of type Self::Error if the merge process fails.

Examples

use rust_decimal::Decimal;
use optionstratlib_math::geometrics::{Arithmetic, GeometricObject, MergeOperation};
use optionstratlib_math::curves::{Curve, Point2D};

let curve1 = Curve::from_vector(vec![
    Point2D::new(Decimal::ZERO, Decimal::ZERO),
    Point2D::new(Decimal::ONE, Decimal::ONE),
]);
let curve2 = Curve::from_vector(vec![
    Point2D::new(Decimal::ZERO, Decimal::ONE),
    Point2D::new(Decimal::ONE, Decimal::TWO),
]);

// Merge two curves by adding their values
let result_curve = Curve::merge(&[&curve1, &curve2], MergeOperation::Add);

Notes

• This trait is designed to be implemented for specific curve types which define how the merging will occur. The associated error type should capture and communicate any issues encountered during operations.
• The implementation may need to handle cases where curves have different domains or sampling points.

Required Associated Types

type Error

The error type returned when merging operations fail

Required Methods

fn merge( geometries: &[&Input], operation: MergeOperation, ) -> Result<Input, Self::Error>

Combines multiple geometries into one using the specified merge operation.

Errors

Returns the implementation’s Self::Error when the input slice is empty, when the selected operation is undefined for the provided geometries, or when axis alignment fails.

fn merge_with( &self, other: &Input, operation: MergeOperation, ) -> Result<Input, Self::Error>

Merges the current curve with another curve using the specified merge operation.

Errors

Same failure surface as merge applied to the two-element collection [self, other].

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Arithmetic<Curve> for Curve

Implements the CurveArithmetic trait for the Curve type, providing functionality for merging multiple curves using a specified mathematical operation and performing arithmetic operations between two curves.

type Error = CurveError

impl Arithmetic<Surface> for Surface

type Error = SurfaceError