Enum Schedule 

pub enum Schedule {
    Repeating {
        value_type: ValueType,
        value: f64,
        periods: u32,
    },
    Custom {
        value_type: ValueType,
        values: Vec<f64>,
    },
}

Sparse or repeating schedule of rates or payments.

Construct with Schedule::new_repeating / Schedule::new_custom (fallible FinanceResult) so non-finite values are rejected without panicking.

Examples

use finance_solution::{Schedule, ValueType};

// Repeating 5% for three periods
let rates = Schedule::new_repeating(ValueType::Rate, 0.05, 3)?;
assert_eq!(rates.len(), 3);
assert_eq!(rates.get(0), Some(0.05));
assert_eq!(rates.get(3), None); // OOB → Option, not panic

// Custom payment ladder
let pmts = Schedule::new_custom(ValueType::Payment, &[100.0, 110.0, 120.0])?;
assert_eq!(pmts.get(1), Some(110.0));

// Invalid input is Err, not abort
assert!(Schedule::new_repeating(ValueType::Rate, f64::NAN, 1).is_err());
assert!(Schedule::new_custom(ValueType::Payment, &[]).is_err());

Variants

Repeating

Fields

value_type: ValueType

value: f64

periods: u32

Custom

Fields

value_type: ValueType

values: Vec<f64>

Implementations

impl Schedule

pub fn new_repeating( value_type: ValueType, value: f64, periods: u32, ) -> FinanceResult<Self>

Repeating constant value for periods steps.

Errors

FinanceError::NonFinite if value is not finite.

pub fn new_custom(value_type: ValueType, values: &[f64]) -> FinanceResult<Self>

Custom value series (one entry per period).

Errors

FinanceError::NonFinite if any value is not finite; FinanceError::EmptyInput if values is empty.

pub fn is_payment(&self) -> bool

pub fn is_rate(&self) -> bool

pub fn value_type(&self) -> &ValueType

pub fn value(&self) -> Option<f64>

Constant value for a repeating schedule; None for custom series.

pub fn get(&self, index: usize) -> Option<f64>

Value at a 0-based index, or None if out of range.

pub fn max(&self) -> Option<f64>

Maximum value in the schedule, if any.

pub fn len(&self) -> usize

Number of periods / entries.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Schedule

fn clone(&self) -> Schedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schedule

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

Formats the value using the given formatter.