Struct PreparedGeneralRietveldObjective 

pub struct PreparedGeneralRietveldObjective { /* private fields */ }

Reusable complete physical objective for one accepted native state.

Implementations

impl PreparedGeneralRietveldObjective

pub fn new( input: RietveldInput, options: RietveldCalculationOptions, layout: RietveldParameterLayout, ) -> Result<Self, RietveldGeneralObjectiveError>

Prepare structural products and explicit global/background columns.

The structural Jacobian is materialized when it fits under the default memory ceiling. Larger objectives retain matrix-free structural products; selected experiment/background columns remain explicit.

Errors

Returns RietveldGeneralObjectiveError for invalid state or derivative layout mismatches.

pub fn new_with_max_linearization_elements( input: RietveldInput, options: RietveldCalculationOptions, layout: RietveldParameterLayout, max_linearization_elements: usize, ) -> Result<Self, RietveldGeneralObjectiveError>

Prepare a complete objective under an explicit dense-memory ceiling.

A zero ceiling forces matrix-free products. Requests whose native structural Jacobian fits within the ceiling materialize it once and reuse it for every gradient and normal product at this state.

Errors

Returns RietveldGeneralObjectiveError for invalid state, derivative layout mismatches, or failed structural products.

pub const fn uses_dense_linearization(&self) -> bool

Return whether this state reuses a bounded dense structural Jacobian.

pub const fn preparation_evaluation_count(&self) -> usize

Return expensive model products consumed while preparing the gradient.

pub const fn normal_product_evaluation_count(&self) -> usize

Return expensive model products consumed by one normal-product call.

pub const fn jvp_evaluation_count(&self) -> usize

Return expensive model products consumed by one forward-product call.

pub const fn layout(&self) -> &RietveldParameterLayout

Borrow the complete stable physical layout.

pub const fn calculation(&self) -> &RietveldCalculation

Borrow the accepted-state calculation used for global columns.

pub fn free_linearization( &self, derivative: &ConstraintDerivativeMatrix, ) -> Result<Option<PreparedGeneralFreeLinearization>, RietveldGeneralObjectiveError>

Project the cached dense objective into weighted scaled-free rows.

Returns None for the bounded matrix-free fallback. The derivative matrix maps scaled free coordinates to the complete physical layout.

Errors

Returns RietveldGeneralObjectiveError for incompatible dimensions or failed dense products.

pub fn jvp( &self, direction: &[f64], ) -> Result<(Vec<f64>, Vec<f64>), RietveldGeneralObjectiveError>

Calculate profile values and one complete physical directional derivative.

Errors

Returns RietveldGeneralObjectiveError for a wrong direction or numerical product failure.

pub fn vjp( &self, sample_weights: &[f64], ) -> Result<Vec<f64>, RietveldGeneralObjectiveError>

Apply the complete physical Jacobian transpose.

Errors

Returns RietveldGeneralObjectiveError for sample shape or engine product failures.

pub fn normal_product( &self, direction: &[f64], damping: f64, ) -> Result<Vec<f64>, RietveldGeneralObjectiveError>

Apply J^T W J + damping I in complete physical coordinates.

Errors

Returns RietveldGeneralObjectiveError for invalid damping or product state.

pub fn gradient( &self, ) -> Result<(Vec<f64>, Vec<f64>), RietveldGeneralObjectiveError>

Calculate the complete accepted-state gradient.

Errors

Returns RietveldGeneralObjectiveError for residual or product state.