pub struct FtpResult { /* private fields */ }Expand description
Main structure holding all FTP calculation inputs and outputs.
§Examples
use ftp_core::{FtpResult, ComputeMethod};
use ndarray::array;
let mut result = FtpResult::new(
array![[1000.0]],
array![[1.0, 0.5, 0.2]],
array![[0.01, 0.02]],
);
result.compute(ComputeMethod::Stock).unwrap();
assert!(result.stock_amort().is_some());Implementations§
Source§impl FtpResult
impl FtpResult
Sourcepub fn new(
input_outstanding: Array2<f64>,
input_profiles: Array2<f64>,
input_rate: Array2<f64>,
) -> Self
pub fn new( input_outstanding: Array2<f64>, input_profiles: Array2<f64>, input_rate: Array2<f64>, ) -> Self
Creates a new FtpResult with the given input matrices.
Sourcepub fn compute(&mut self, method: ComputeMethod) -> Result<(), FtpError>
pub fn compute(&mut self, method: ComputeMethod) -> Result<(), FtpError>
Runs the FTP computation using the specified method.
pub fn input_outstanding(&self) -> &Array2<f64>
pub fn input_profiles(&self) -> &Array2<f64>
pub fn input_rate(&self) -> &Array2<f64>
pub fn stock_amort(&self) -> Option<&Array2<f64>>
pub fn stock_instal(&self) -> Option<&Array2<f64>>
pub fn varstock_amort(&self) -> Option<&Array2<f64>>
pub fn varstock_instal(&self) -> Option<&Array2<f64>>
pub fn ftp_rate(&self) -> Option<&Array2<f64>>
pub fn ftp_int(&self) -> Option<&Array2<f64>>
pub fn market_rate(&self) -> Option<&Array2<f64>>
Auto Trait Implementations§
impl Freeze for FtpResult
impl RefUnwindSafe for FtpResult
impl Send for FtpResult
impl Sync for FtpResult
impl Unpin for FtpResult
impl UnsafeUnpin for FtpResult
impl UnwindSafe for FtpResult
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more