Struct CorrelationFunction 

pub struct CorrelationFunction { /* private fields */ }

Correlation-function calculator. Stateless container of bin parameters.

Implementations

impl CorrelationFunction

pub fn new(n_bins: usize, r_max: F, r_min: F) -> Result<Self, ComputeError>

pub fn n_bins(&self) -> usize

pub fn bin_edges(&self) -> &Array1<F>

pub fn bin_centers(&self) -> &Array1<F>

Trait Implementations

impl Clone for CorrelationFunction

fn clone(&self) -> CorrelationFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Compute for CorrelationFunction

type Args<'a> = CorrelationArgs<'a>

Non-frame inputs, with a borrow tied to the frame-slice lifetime.

type Output = Vec<CorrelationFunctionResult>

Finalized output type.

fn compute<'a, FA: FrameAccess + Sync + 'a>( &self, frames: &[&'a FA], args: CorrelationArgs<'a>, ) -> Result<Vec<CorrelationFunctionResult>, ComputeError>

Run the analysis. frames may be empty; implementations that need at least one frame return ComputeError::EmptyInput.

impl Debug for CorrelationFunction

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

Formats the value using the given formatter.