Numeric guided operations

Find the Numeric guided operations and consult the identifiers, inputs and results reported in the catalog.

How to use this family

Start from inputs, options and model. For the dataset_* variants, identify the Dataset and canonical variables, as well as the Session reference if exposed. For a fit, check together the set of observations, model, weights and meaning of the parameters. Evaluation operations use the model already defined. Fit uncertainty and quality require the assumptions indicated by the provider.

Function index

numeric.analytic_signal

Builds the analytic signal from a real signal. Its magnitude is the envelope.

Signature
numeric.analytic_signal(values)
Arguments
values
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include real, imaginary, amplitude, n, method.

Back to the list

numeric.baseline

Estimates or applies the baseline level of the series.

Signature
numeric.baseline(x, y, anchor_x, anchor_y)
Arguments
x y anchor_x anchor_y
Shape rule
same_length_xy
Unit rule
preserve_y
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), 2, 2. Press Preview fields. The results include x, baseline, corrected, method, degree, coefficients, original_x, original_y.

Back to the list

numeric.cartesian_coordinates

Reconstructs the Cartesian components from a polar representation.

Signature
numeric.cartesian_coordinates(first_coordinate, second_coordinate)
Arguments
first_coordinate second_coordinate
Shape rule
paired_vectors
Unit rule
explicit_frame
Result shape
paired_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include x, y, points, frame.origin, frame.theta_zero, frame.clockwise, frame.angle_unit, frame.unwrap_policy.

Back to the list

numeric.common_range

Finds the abscissa range shared by the series.

Signature
numeric.common_range(x1, x2)
Arguments
x1 x2
Shape rule
two_vectors
Unit rule
compatible
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include overlap, min, max, width, x1_min, x1_max, x2_min, x2_max.

Back to the list

numeric.comparison_curves

Brings curves into a comparison according to the chosen mode.

Signature
numeric.comparison_curves(mode, x1, y1, x2, y2, options)
Arguments
mode x1 y1 x2 y2 options
Shape rule
bounded_curves
Unit rule
Units declared by whoever prepares the inputs.
Result shape
bounded_curve
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "difference", vector(0,1,2,3), vector(1,3,3.9,7), vector(0,1,2,3), vector(0,2,3,5). Press Preview fields. The results include x, values, invalid_count, domain_min, domain_max, method, normalization, offset.

Back to the list

numeric.complex_binary.add

Sum of the operands.

Signature
numeric.complex_binary.add(real_a, imaginary_a, real_b, imaginary_b)
Arguments
real_a imaginary_a real_b imaginary_b
Shape rule
matching_parts_and_operands
Unit rule
operation_specific
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2, 2. Press Preview fields. The results include real, imaginary.

Back to the list

numeric.complex_binary.divide

Quotient.

Signature
numeric.complex_binary.divide(real_a, imaginary_a, real_b, imaginary_b)
Arguments
real_a imaginary_a real_b imaginary_b
Shape rule
matching_parts_and_operands
Unit rule
operation_specific
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2, 2. Press Preview fields. The results include real, imaginary.

Back to the list

numeric.complex_binary.multiply

Product.

Signature
numeric.complex_binary.multiply(real_a, imaginary_a, real_b, imaginary_b)
Arguments
real_a imaginary_a real_b imaginary_b
Shape rule
matching_parts_and_operands
Unit rule
operation_specific
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2, 2. Press Preview fields. The results include real, imaginary.

Back to the list

numeric.complex_binary.subtract

Difference between the first and second operands.

Signature
numeric.complex_binary.subtract(real_a, imaginary_a, real_b, imaginary_b)
Arguments
real_a imaginary_a real_b imaginary_b
Shape rule
matching_parts_and_operands
Unit rule
operation_specific
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2, 2. Press Preview fields. The results include real, imaginary.

Back to the list

numeric.complex_evaluate

Evaluates the complex model at the requested abscissas.

Signature
numeric.complex_evaluate(model, frequency)
Arguments
model frequency
Shape rule
positive_frequency_rows
Unit rule
physical_channel_units
Result shape
physical_complex_prediction
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.complex_fit

Estimates parameters against complex observations. Check the representation of the components.

Signature
numeric.complex_fit(model, frequency, observations, measurement)
Arguments
model frequency observations measurement
Shape rule
finite_matched_rows_absolute_covariance
Unit rule
physical_parameters_dimensionless_objective
Result shape
joint_complex_fit
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.complex_from_polar

Reconstructs the complex value from magnitude and phase.

Signature
numeric.complex_from_polar(magnitude, phase, options)
Arguments
magnitude phase options
Shape rule
finite_matched_arrays
Unit rule
explicit_phase_amplitude_units
Result shape
physical_complex_observations
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.complex_model_compose

Builds the structured recipe of a complex model.

Signature
numeric.complex_model_compose(recipe)
Arguments
recipe
Shape rule
bounded_complex_formula_and_units
Unit rule
physical_channel_units
Result shape
frozen_complex_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a complex model recipe with representation convention, coefficients and channel units. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.complex_residuals

Computes the complex residual between measurements and model.

Signature
numeric.complex_residuals(model, frequency, observations, measurement)
Arguments
model frequency observations measurement
Shape rule
finite_matched_rows_absolute_covariance
Unit rule
physical_channels_dimensionless_objective
Result shape
complex_evaluation_diagnostics
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.complex_unary.conjugate

Conjugates the complex data, inverting the sign of the imaginary part.

Signature
numeric.complex_unary.conjugate(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
Keep the relevant unit.
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include real, imaginary.

Back to the list

numeric.complex_unary.imag

Selects the imaginary part of the complex result.

Signature
numeric.complex_unary.imag(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.complex_unary.magnitude

Computes the magnitude, per sample or per vector according to the indicated form.

Signature
numeric.complex_unary.magnitude(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.complex_unary.magnitude_squared

Computes the squared magnitude.

Signature
numeric.complex_unary.magnitude_squared(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.complex_unary.phase_deg

Expresses the argument of the complex quantity in degrees.

Signature
numeric.complex_unary.phase_deg(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.complex_unary.phase_rad

Expresses the argument of the complex quantity in radians.

Signature
numeric.complex_unary.phase_rad(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.complex_unary.real

Selects the real part of the complex result.

Signature
numeric.complex_unary.real(real_part, imaginary_part)
Arguments
real_part imaginary_part
Shape rule
matching_parts_or_scalar
Unit rule
operation_specific
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.cumulative_sum

Produces the cumulative sum in element order.

Signature
numeric.cumulative_sum(values)
Arguments
values
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include values, total, n, method.

Back to the list

numeric.curve_model_evaluate

Computes the ordinates for an already defined curve model.

Signature
numeric.curve_model_evaluate(model, query)
Arguments
model query
Shape rule
query_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
xy_points
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.curve_model_evaluate(record("model","circular_arc","center_x",0,"center_y",0,"radius",1,"angle_start",0,"angle_end",1.5707963267948966),vector(0,1)),"y") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.curve_model_fit

Estimates a curve model from the observations.

Signature
numeric.curve_model_fit(model, x, y)
Arguments
model x y
Shape rule
paired_vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_state
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.curve_model_fit("pchip",vector(0,1,2,3),vector(1,3,5,7)),"source_count") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.curve_model_parameter_state

Extracts the parameter state of the curve described by the model.

Signature
numeric.curve_model_parameter_state(model, parameters)
Arguments
model parameters
Shape rule
bounded_1_to_127_parameters
Unit rule
Units declared by whoever prepares the inputs.
Result shape
editable_model_state
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.curve_model_parameter_state(record("model","circular_arc","center_x",0,"center_y",0,"radius",1,"angle_start",0,"angle_end",1.5707963267948966),vector(0,0,2,0,1.5707963267948966)),"parameters") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.curve_model_project

Projects the curve model according to the coordinate and parameter contract.

Signature
numeric.curve_model_project(model, x, y)
Arguments
model x y
Shape rule
paired_vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
xy_points
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.curve_model_project(record("model","circular_arc","center_x",0,"center_y",0,"radius",1,"angle_start",0,"angle_end",1.5707963267948966),vector(1,0),vector(0,1)),"distance") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.curve_model_residual

Computes the residuals between curve and observations.

Signature
numeric.curve_model_residual(model, x, y)
Arguments
model x y
Shape rule
paired_vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
geometric_residuals
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.curve_model_residual(record("model","circular_arc","center_x",0,"center_y",0,"radius",1,"angle_start",0,"angle_end",1.5707963267948966),vector(1,0),vector(0,1)),"rmse") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.dataset_array_binary

Applies an element-wise binary operation to aligned canonical variables.

Signature
numeric.dataset_array_binary(session, dataset_id, left_variable_id, right_variable_id, operation)
Arguments
session dataset_id left_variable_id right_variable_id operation
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
dataset_rows
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "voltage", "reference", "add". Press Preview fields. The results include values, dataset_id, left_variable_id, right_variable_id, left_source_unit, right_source_unit, selection_id.

Back to the list

numeric.dataset_array_scalar

Combines each value of the canonical variable with a scalar.

Signature
numeric.dataset_array_scalar(session, dataset_id, variable_id, scalar, operation)
Arguments
session dataset_id variable_id scalar operation
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
dataset_rows
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "voltage", 2, "multiply". Press Preview fields. The results include values, dataset_id, variable_id, source_unit, selection_id.

Back to the list

numeric.dataset_array_unary

Transforms each value of the canonical variable.

Signature
numeric.dataset_array_unary(session, dataset_id, variable_id, operation)
Arguments
session dataset_id variable_id operation
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
dataset_rows
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "voltage", "abs". Press Preview fields. The results include values, dataset_id, variable_id, source_unit, selection_id.

Back to the list

numeric.dataset_baseline

Estimates the baseline along the coordinates of the canonical variable.

Signature
numeric.dataset_baseline(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include x, baseline, corrected, method, degree, coefficients, original_x, original_y.

Back to the list

numeric.dataset_cumulative_integrate

Progressively integrates the canonical variable along the chosen coordinate.

Signature
numeric.dataset_cumulative_integrate(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include x, integral, n, method, dataset_id, x_variable_id, y_variable_id, x_unit.

Back to the list

numeric.dataset_differentiate

Differentiates the canonical variable with respect to the chosen coordinate.

Signature
numeric.dataset_differentiate(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include x, dy_dx, n, method, kernel, dataset_id, x_variable_id, y_variable_id.

Back to the list

numeric.dataset_expression

Evaluates an expression with symbols associated with variables or parameters.

Signature
numeric.dataset_expression(session, expression, bindings, parameters)
Arguments
session expression bindings parameters
Shape rule
explicit_canonical_variable_row_window
Unit rule
CORE_UNIT_DIMENSION_API_v1
Result shape
values_units_and_absolute_source_row_lineage
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "v*2", record("v",record("dataset_id","worksheet_practice","variable_id","voltage")), record(). In Options use start=0 count=4 output_unit="V". Press Preview fields. The results include schema, values, unit, dimensions.schema, dimensions.expression, dimensions.symbol_units.v, dimensions.symbol_units.pi, dimensions.symbol_units.e.

Back to the list

numeric.dataset_find_peaks

Selects the local extrema in a canonical series according to the requested criteria.

Signature
numeric.dataset_find_peaks(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
features
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include indices, x, heights, prominences, widths, left_x, right_x, n.

Back to the list

numeric.dataset_grid_info

Describes the grid of the canonical variable and the step conditions.

Signature
numeric.dataset_grid_info(session, dataset_id, x_variable_id)
Arguments
session dataset_id x_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s". Press Preview fields. The results include n, uniform, step, step_mean, step_median, step_min, step_max, step_std.

Back to the list

numeric.dataset_integrate

Integrates a canonical variable with respect to its abscissas over the included rows.

Signature
numeric.dataset_integrate(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include value, n, x_min, x_max, method, kernel, dataset_id, x_variable_id.

Back to the list

numeric.dataset_interpolate

Estimates the canonical variable at the positions required by the output grid.

Signature
numeric.dataset_interpolate(session, dataset_id, x_variable_id, y_variable_id, target_x)
Arguments
session dataset_id x_variable_id y_variable_id target_x
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage", vector(0.5,1,1.5). Press Preview fields. The results include xq, yq, method, extrapolation, n_source, n_query, kernel, dataset_id.

Back to the list

numeric.dataset_nonlinear_fit

Fits a declarative model to two canonical variables. Identifies abscissa and response by ID.

Signature
numeric.dataset_nonlinear_fit(session, dataset_id, x_variable_id, y_variable_id, model, parameters)
Arguments
session dataset_id x_variable_id y_variable_id model parameters
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

Choose the model in the selector and fill in its parameters.

  • linear. Straight line (intercept + slope × x). Provide intercept and slope in this order.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "linear", vector(1.8,2.8). Choose the model linear. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • polynomial_fit. Polynomial for curve fitting. The number of initial values determines the degree. The coefficients are ordered from the highest power down to the constant.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "polynomial_fit", vector(2,0.8,1). Choose the model polynomial_fit. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • gaussian. Gaussian profile with amplitude, center, non-zero width and offset, in this order.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "gaussian", vector(2.8,1.5,0.5,0.2). Choose the model gaussian. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • exponential. Profile amplitude × exp(rate × x) + offset. Use amplitude, rate and offset in this order.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "exponential", vector(1.8,-0.3,1). Choose the model exponential. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • expression. Expression with declared symbols. In the one-parameter case use, for example, expression=”s*x” and parameter_ids=”s”.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "expression", vector(2.8). Choose the model expression. Set expression="s*x", parameter_ids="s" in the model fields. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • power_law. Power law: scale × x raised to an exponent. The initial values are scale and exponent. The retained abscissas must be positive.

    Example with synthetic data. Import the models Dataset. Enter, in order, @session, "worksheet_model_tests", "x", "power_law", vector(2.8,1.4). Choose the model power_law. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

Back to the list

numeric.dataset_polynomial_fit

Fits a polynomial to the canonical coordinates and measurements.

Signature
numeric.dataset_polynomial_fit(session, dataset_id, x_variable_id, y_variable_id, degree)
Arguments
session dataset_id x_variable_id y_variable_id degree
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage", 2. Press Preview fields. The results include predicted, residuals, weighted_residuals, objective, sse, rss, rmse, residual_rmse.

Back to the list

numeric.dataset_reduce_summary

Reduces the canonical values to a summary.

Signature
numeric.dataset_reduce_summary(session, dataset_id, variable_id)
Arguments
session dataset_id variable_id
Shape rule
chunk_composable
Unit rule
Keep the relevant unit.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "voltage". Press Preview fields. The results include count, sum, mean, min, max, requested_dimension, input_shape, output_shape.

Back to the list

numeric.dataset_resample

Resamples the canonical variable on the requested coordinates.

Signature
numeric.dataset_resample(session, dataset_id, x_variable_id, y_variable_id, target_x)
Arguments
session dataset_id x_variable_id y_variable_id target_x
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage", vector(0.5,1,1.5). Press Preview fields. The results include x, y, method, extrapolation, n_source, n_output, grid_kind, dataset_id.

Back to the list

numeric.dataset_resample_uniform

Resamples the canonical variable with a uniform step.

Signature
numeric.dataset_resample_uniform(session, dataset_id, x_variable_id, y_variable_id, step)
Arguments
session dataset_id x_variable_id y_variable_id step
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage", 2. Press Preview fields. The results include x, y, step, start, stop_requested, stop_actual, n_source, n_output.

Back to the list

numeric.dataset_smooth

Applies smoothing to a canonical variable with the parameters of the chosen method.

Signature
numeric.dataset_smooth(session, dataset_id, x_variable_id, y_variable_id)
Arguments
session dataset_id x_variable_id y_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "time_s", "voltage". Press Preview fields. The results include x, y, residuals, method, window, degree, endpoint_policy, original_count.

Back to the list

numeric.dataset_statistics

Descriptive statistics of a canonical variable.

Signature
numeric.dataset_statistics(session, dataset_id, variable_id)
Arguments
session dataset_id variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example of guided operation. session = @session, dataset_id = “worksheet_practice” and variable_id = “voltage”. The variance_sample field gives about 0.533333 V².

Back to the list

numeric.dataset_weighted_statistics

Weighted statistics on canonical data.

Signature
numeric.dataset_weighted_statistics(session, dataset_id, variable_id, weight_variable_id)
Arguments
session dataset_id variable_id weight_variable_id
Shape rule
dataset_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @session, "worksheet_practice", "voltage", "reference". Press Preview fields. The results include n_total, n_input, n_valid, n_nonfinite, n_zero_weight, n_positive_weight, n_positive, sum_weights.

Back to the list

numeric.derived_properties

Evaluates properties derived from a CORE plan and from the parameter values.

Signature
numeric.derived_properties(plan)
Arguments
plan
Shape rule
CORE_derived_properties_1_to_32
Unit rule
explicit_CORE_plan
Result shape
named_values_full_correlated_covariance_and_domain_status
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.detrend

Estimates and removes the background trend before residual analysis.

Signature
numeric.detrend(values)
Arguments
values
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include values, trend, method, n.

Back to the list

numeric.digital_filter

Application of a digital filter.

Signature
numeric.digital_filter(y, numerator, denominator)
Arguments
y numerator denominator
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,3,5,7,9), vector(0.5,0.5), 1. Press Preview fields. The results include y, b, a, method, initial_state.

Back to the list

numeric.digitization_covariance

Uses the digitization uncertainty identity for the covariance. The preserved canonical reference is required.

Signature
numeric.digitization_covariance(state, axis)
Arguments
state axis
Shape rule
one_to_512_original_points
Unit rule
physical_axis_units
Result shape
original_order_full_covariance
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from an uncertainty captured by the digitization, with its identity preserved and its order unchanged. The calculation uses the preserved structure to propagate covariance and shared factors.

Follow the two-point uncertainty script. Check the independent results and the shared contribution, then keep the identity before computing the covariance.

Back to the list

numeric.digitization_uncertainty

Queries the uncertainty information associated with the digitization of the source.

Signature
numeric.digitization_uncertainty(linearization, specification)
Arguments
linearization specification
Shape rule
one_to_4096_original_points
Unit rule
explicit_pixel_distribution_and_physical_units
Result shape
physical_marginals_and_shared_factors
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The digitization contract includes the calibration and point-position contributions. It requires the coordinates and the uncertainty sources associated with their acquisition. The generic record used in the test was refused.

Follow the two-point uncertainty script. Check the independent results and the shared contribution, then keep the identity before computing the covariance.

Back to the list

numeric.ecdf

Empirical cumulative distribution.

Signature
numeric.ecdf(values)
Arguments
values
Shape rule
vector
Unit rule
preserve_support
Result shape
support_and_probability
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include support, counts, probability, n_input, n_valid, n_nonfinite.

Back to the list

numeric.event_period

Estimates the period from ordered events or time crossings.

Signature
numeric.event_period(crossings)
Arguments
crossings
Shape rule
finite_nondecreasing
Unit rule
seconds
Result shape
bounded_timing_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Physical durations require crossings in s, and window metrics require dimensionless coefficients and a positive sampling frequency. See the check on units and contracts.

Back to the list

numeric.expression_analyze

Analyzes the form of the expression and the allowed symbols.

Signature
numeric.expression_analyze(request)
Arguments
request
Shape rule
explicit_interval_scalar_parameters
Unit rule
CORE_UNIT_DIMENSION_API_v1
Result shape
bounded_roots_intersections_local_extrema_with_classification
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, record("expression","x^2-4","variable","x","interval",vector(0,4),"symbol_units",record("x","1"),"mode","roots") . In Options use sample_count=33. Press Preview fields. The results include schema, mode, status, expression, expression2, variable, interval, variable_unit.

Back to the list

numeric.expression_dimensions

Checks the physical dimensions of the expression, given the symbols and their units.

Signature
numeric.expression_dimensions(expression, symbol_units, output_unit, unknown_parameter_ids)
Arguments
expression symbol_units output_unit unknown_parameter_ids
Shape rule
bounded_symbol_metadata
Unit rule
CORE_UNIT_DIMENSION_API_v1
Result shape
dimensional_receipt
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "p*p+q", record("p","V","q","V^2"), "V^2". Press Preview fields. The results include schema, expression, symbol_units.p, symbol_units.q, symbol_scales.p, symbol_scales.q, used_symbols.item1, used_symbols.item2.

Back to the list

numeric.expression_evaluate

Evaluates an expression on the values associated with the symbols and on the declared units.

Signature
numeric.expression_evaluate(expression, symbols, symbol_units)
Arguments
expression symbols symbol_units
Shape rule
finite_real_scalar_or_equal_vectors_max65536
Unit rule
CORE_UNIT_DIMENSION_API_v1
Result shape
typed_values_unit_dimensions
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "p*p+q", record("p",3,"q",4), record("p","1","q","1"). Press Preview fields. The results include schema, values, unit, dimensions.schema, dimensions.expression, dimensions.symbol_units.p, dimensions.symbol_units.q, dimensions.symbol_units.pi.

Back to the list

numeric.f_cdf

Returns the cumulative probability of the F distribution at the chosen degrees of freedom.

Signature
numeric.f_cdf(f, numerator_df, denominator_df)
Arguments
f numerator_df denominator_df
Shape rule
equal_shape_or_scalar
Unit rule
Dimensionless output.
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2. Press Preview fields. The results include values.

Back to the list

numeric.fft

Fast discrete Fourier transform.

Signature
numeric.fft(values)
Arguments
values
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example of guided operation. values = B1:B16. The real field, applied without a row window, shows 32 in the first bin.

Back to the list

numeric.fft_spectrum_quality

Returns quality descriptors from the spectrum computed with the FFT.

Signature
numeric.fft_spectrum_quality(signal, sample_step)
Arguments
signal sample_step
Shape rule
real_vector_and_positive_step
Unit rule
explicit_response_and_inverse_coordinate
Result shape
spectrum_component_columns_and_scalar_facts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 0.25. Press Preview fields. The results include N, fs, df, coherent_gain, amp, Nh, fund_bin, fund_amp.

Back to the list

numeric.find_peaks

Identifies local peaks with the criteria of the function.

Signature
numeric.find_peaks(x, y)
Arguments
x y
Shape rule
same_length_xy
Unit rule
preserve_y
Result shape
features
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include indices, x, heights, prominences, widths, left_x, right_x, n.

Back to the list

numeric.fit_bootstrap

Estimates the variability of the fit by resampling. Reproduce the sampling and seed choices.

Signature
numeric.fit_bootstrap(model, predictors, response, plan)
Arguments
model predictors response plan
Shape rule
captured_fitted_model_and_CORE_bootstrap_plan
Unit rule
explicit_CORE_plan
Result shape
parameter_draws_and_bounded_refit_receipt
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.fit_bootstrap_draw

Draws one replicate from the prepared bootstrap state.

Signature
numeric.fit_bootstrap_draw(state, seed)
Arguments
state seed
Shape rule
bounded_bootstrap_draw
Unit rule
explicit_CORE_plan
Result shape
aligned_replicate_inputs_and_next_seed
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.fit_bootstrap_prepare

Prepares the state to reuse in the bootstrap draws.

Signature
numeric.fit_bootstrap_prepare(model, predictors, response, plan, options)
Arguments
model predictors response plan options
Shape rule
bounded_bootstrap_inputs
Unit rule
explicit_CORE_plan
Result shape
prepared_data_state
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.fit_bootstrap_summarize

Summarizes a set of compatible bootstrap replicates.

Signature
numeric.fit_bootstrap_summarize(state, samples, status, seeds, execution)
Arguments
state samples status seeds execution
Shape rule
bounded_bootstrap_ledger
Unit rule
explicit_CORE_plan
Result shape
shared_covariance_percentiles_and_complete_trial_receipt
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

It requires the unchanged state returned by fit_bootstrap_prepare, one row of parameters per draw, the states and seeds for the same rows, and the execution summary. The script verifies the preparation, the draw and the complete bootstrap.

Back to the list

numeric.fit_characteristics

Describes the observations to prepare or interpret a fit, using paired finite abscissas and responses.

Signature
numeric.fit_characteristics(predictors, response)
Arguments
predictors response
Shape rule
equal_finite_vectors
Unit rule
caller_declared_physical_coordinate_basis
Result shape
bounded_deterministic_shape_hints
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4) , vector(1,3,5,7,9). Press Preview fields. The results include schema, numeric_api, operation, status, reason, observation_count, distinct_predictors, duplicate_predictors.

Back to the list

numeric.fit_formula_compose

Composes the structured declaration of the fit formula, with the symbols and parameters of the model.

Signature
numeric.fit_formula_compose(recipe)
Arguments
recipe
Shape rule
bounded_formula_and_units
Unit rule
explicit_internal_conversion_physical_parameters
Result shape
frozen_expression_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a recipe with an expression, parameter identifiers and consistent units. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.fit_information_criteria

Compares models with information criteria computed on the selection plan.

Signature
numeric.fit_information_criteria(plan)
Arguments
plan
Shape rule
bounded_CORE_model_selection_plan
Unit rule
explicit_CORE_plan
Result shape
Gaussian_log_likelihood_AIC_AICc_BIC
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.fit_initial_guess

Prepares an initial estimate of the parameters for the chosen model.

Signature
numeric.fit_initial_guess(model_kind, predictors, response)
Arguments
model_kind predictors response
Shape rule
equal_finite_vectors
Unit rule
caller_declared_physical_coordinate_basis
Result shape
bounded_initialization_proposal
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "linear", vector(0,1,2,3,4), vector(1,3,5,7,9). Press Preview fields. The results include schema, status, model_kind, purpose, nonlinear_optimization, observation_count, nonfinite_policy, source_mutation.

Back to the list

numeric.fit_input_policy

Consults or prepares the policies that govern the selection and the checks on the fit inputs.

Signature
numeric.fit_input_policy(model, state)
Arguments
model state
Shape rule
captured_model_decisions
Unit rule
Units declared by whoever prepares the inputs.
Result shape
input_policy
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.fit_input_policy("pchip",record()),"order") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.fit_model_catalog

Consults the fit models published by the provider before you declare one.

Signature
numeric.fit_model_catalog(none)
Arguments
none
Shape rule
bounded_model_cards
Unit rule
descriptor_relationships
Result shape
independent_model_descriptors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. The test leaves the optional operands empty. Press Preview fields. The results include schema, models.item1.id, models.item1.version, models.item1.name, models.item1.description, models.item1.descriptor_sha256, models.item1.expression, models.item1.parameter_ids.item1.

Back to the list

numeric.fit_model_compose

Composes a fit recipe consistent with the expected model and parameter types.

Signature
numeric.fit_model_compose(recipe)
Arguments
recipe
Shape rule
bounded_component_recipe
Unit rule
explicit_axis_units_and_parameter_relationships
Result shape
declared_expression_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a composition recipe with public components and parameters. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.fit_observation_signature

Identifies the observations and weights that belong to the fit.

Signature
numeric.fit_observation_signature(observed, weights, response_offset, predictors)
Arguments
observed weights response_offset predictors
Shape rule
equal_positive_weight_retained_rows
Unit rule
caller_declared_response_units
Result shape
bounded_ordered_observation_receipt
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,3,5,7,9), vector(1,1,1,1,1), 0, matrix(vector(1,0,1,1,1,2,1,3,1,4),5,2). Press Preview fields. The results include schema, n, encoding, response_sha256, weights_sha256, log_weight_sum, response_offset, fit_response_sha256.

Back to the list

numeric.fit_profile

Varies one model parameter and re-optimizes according to the declared profile.

Signature
numeric.fit_profile(model, predictors, response, plan)
Arguments
model predictors response plan
Shape rule
exact_retained_observations
Unit rule
explicit_CORE_plan
Result shape
typed_trial_ledger_and_bounded_receipt
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.fit_region_catalog

Consults the regions that can be used when composing fit models.

Signature
numeric.fit_region_catalog(none)
Arguments
none
Shape rule
bounded_model_cards
Unit rule
descriptor_relationships
Result shape
independent_regional_descriptors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. The test leaves the optional operands empty. Press Preview fields. The results include schema, models.item1.id, models.item1.version, models.item1.name, models.item1.description, models.item1.descriptor_sha256, models.item1.increment, models.item1.derivative.

Back to the list

numeric.fit_region_compose

Composes a model declaration that associates regions and parameters.

Signature
numeric.fit_region_compose(recipe)
Arguments
recipe
Shape rule
bounded_regional_recipe
Unit rule
explicit_physical_units
Result shape
declared_expression_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a region recipe with the expected domain form and the coordinates. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.fit_region_selection

Evaluates which observations fall in the regions of the model.

Signature
numeric.fit_region_selection(model;predictors)
Arguments
{model;predictors}
Shape rule
bounded_model;vector
Unit rule
physical_predictor
Result shape
positional_mask_and_region_indices
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.frequency_grid

Builds the bin grid from the sampling frequency and the FFT length.

Signature
numeric.frequency_grid(sample_rate, nfft)
Arguments
sample_rate nfft
Shape rule
scalar_parameters
Unit rule
inverse_time
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include frequency, sample_rate, nfft, df, nyquist, representation, ordering, has_nyquist.

Back to the list

numeric.generalized_least_squares

Estimates the coefficients by generalized least squares, using the error structure.

Signature
numeric.generalized_least_squares(design, response, covariance)
Arguments
design response covariance
Shape rule
matching_rows_square_covariance
Unit rule
explicit_covariance_in_squared_response_units
Result shape
coefficients_covariance_whitened_residuals
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Provide a square symmetric covariance aligned with the observations. For the absolute exercise, use a 4 × 4 identity matrix. The calculation from the Scripts panel succeeds. The guided Job rejects the declaration covariance_unit or asks for it when it is missing.

Back to the list

numeric.grid_info

Describes the extent, order and step of the grid.

Signature
numeric.grid_info(x)
Arguments
x
Shape rule
vector
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) . Press Preview fields. The results include n, uniform, step, step_mean, step_median, step_min, step_max, step_std.

Back to the list

numeric.harmonic_components

Extracts the components at the harmonic frequencies of the fundamental.

Signature
numeric.harmonic_components(orders, expected_frequency, detected_frequency, amplitudes)
Arguments
orders expected_frequency detected_frequency amplitudes
Shape rule
four_equal_vectors
Unit rule
explicit_frequency_and_amplitude
Result shape
component_columns
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 10, 10.2, 1. In Options use fundamental_amplitude=4 level_floor="none". Press Preview fields. The results include component_order, component_expected_frequency, component_frequency, component_frequency_error, component_amplitude, component_level_db, component_percent, fundamental_amplitude.

Back to the list

numeric.harmonic_peak_quality

Describes the quality with which a harmonic peak was identified.

Signature
numeric.harmonic_peak_quality(frequency, amplitude)
Arguments
frequency amplitude
Shape rule
paired_real_vectors
Unit rule
explicit_frequency_and_amplitude
Result shape
component_columns_and_scalar_facts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4) , vector(1,3,5,7,9). Press Preview fields. The results include component_order, component_expected_frequency, component_frequency, component_frequency_error, component_amplitude, component_level_db, component_percent, fundamental_amplitude.

Back to the list

numeric.histogram

Counts over intervals.

Signature
numeric.histogram(values, edges)
Arguments
values edges
Shape rule
vector
Unit rule
preserve_edges
Result shape
bin_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,3,5,7,9) , vector(0,2,4,6,8,10). In Options use bin_mode="edges". Press Preview fields. The results include edges, centers, counts, relative_frequency, cumulative_frequency, bin_mode, n_input, n_valid.

Back to the list

numeric.histogram_summary

Summarizes the distribution in classes with declared edges and counts.

Signature
numeric.histogram_summary(values)
Arguments
values
Shape rule
vector
Unit rule
preserve_edges
Result shape
typed_uint64_counts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, A1:A8 . In Options use mode="bounded" bins=4 domain_low=0 domain_high=256. Press Preview fields. The results include total_count, finite_count, nan_count, positive_inf_count, negative_inf_count, schema, counts, mode.

Back to the list

numeric.hypothesis_test

Statistic and inference for an explicit test.

Signature
numeric.hypothesis_test(method, first_values, second_values)
Arguments
method first_values second_values
Shape rule
method_specific
Unit rule
Field-specific unit.
Result shape
test_result
Provider
math.numeric · NUMERIC_API_v1

Example of a test on a mean. Explicitly provide empty() as the second sample when you choose one_sample_t.

Contract values

one_sample_t
In method, compares the mean of the first sample with mu0, which defaults to zero. Leave the second sample empty.
independent_t
In method, compares the means of two independent samples with a common variance.
welch_t
In method, compares the means of independent samples with separately estimated variances.
paired_t
In method, provide two paired series in the same order. The t test works on the differences.
mann_whitney
In method, uses a rank comparison for two independent samples.
signed_rank
In method, uses the signed ranks of the paired differences.
two_sided
In Options, use alternative=”two_sided” to assess deviations in both directions. This is the default.
greater
In Options, use alternative=”greater” for the alternative in which the first sample is greater than the declared reference.
less
In Options, use alternative=”less” for the alternative in which the first sample is less than the declared reference.

Back to the list

numeric.ifft

Inverse fast discrete Fourier transform.

Signature
numeric.ifft(real, imaginary)
Arguments
real imaginary
Shape rule
same_length
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(32,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0) , vector(0,0,0,0,-8,0,0,0,0,0,0,0,8,0,0,0). Press Preview fields. The results include real, imaginary, nfft, input_length, normalization, ordering.

Back to the list

numeric.implicit_evaluate

Evaluates the implicit residual at the requested points.

Signature
numeric.implicit_evaluate(model, x, y)
Arguments
model x y
Shape rule
matched_observed_coordinates
Unit rule
declared_equation_unit
Result shape
equation_values_and_optional_parameter_jacobian
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.implicit_fit

Estimates an implicit relation between coordinates.

Signature
numeric.implicit_fit(model, x, y)
Arguments
model x y
Shape rule
matched_original_observations
Unit rule
declared_equation_and_parameter_units
Result shape
physical_parameters_and_equation_residual_facts
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.implicit_model_compose

Composes the structured model of an implicit relation between coordinates.

Signature
numeric.implicit_model_compose(recipe)
Arguments
recipe
Shape rule
bounded_two_coordinate_formula
Unit rule
CORE_formula_units
Result shape
versioned_implicit_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses an implicit recipe with identified form, coordinates and parameters. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.implicit_query

Queries an implicit model starting from the given coordinates.

Signature
numeric.implicit_query(model, queries, branch)
Arguments
model queries branch
Shape rule
one_to_64_independent_queries
Unit rule
declared_coordinate_units
Result shape
checked_branch_roots_and_partial_derivatives
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.least_squares

Minimizes the squared deviation. For the linear form, check the rank and compatibility of the matrix.

Signature
numeric.least_squares(design, response, weights)
Arguments
design response weights
Shape rule
matching_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,0,1,1,1,2,1,3,1,4),5,2), vector(1,3,5,7,9), vector(1,1,1,1,1). Press Preview fields. The results include predicted, residuals, weighted_residuals, objective, sse, rss, rmse, residual_rmse.

Back to the list

numeric.linear_matrix

Sets up a linear relation between vectors through a matrix.

Signature
numeric.linear_matrix(action, matrix, other)
Arguments
action matrix other
Shape rule
two_dimensional
Unit rule
Units declared by whoever prepares the inputs.
Result shape
action_specific
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "inverse", matrix(vector(2,0,0,4),2,2), empty(). In Options use rank_policy="error". Press Preview fields. The results include rows, cols, rank, rank_tolerance, condition_number, value_real, value_imaginary.

Alternative test in Cell & Formula. Enter =field(numeric.linear_matrix("inverse",matrix(vector(2,0,0,4),2,2),empty(),record()),"value_real") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.linear_regression

Linear regression on aligned data.

Signature
numeric.linear_regression(x, y, weights)
Arguments
x y weights
Shape rule
same_length
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4), vector(1,3,5,7,9), vector(1,1,1,1,1). Press Preview fields. The results include predicted, residuals, weighted_residuals, objective, sse, rss, rmse, residual_rmse.

Back to the list

numeric.local_cloud_fit

Estimates a local model in the region of a point cloud.

Signature
numeric.local_cloud_fit(x, y, query)
Arguments
x y query
Shape rule
matched_source_vectors_and_queries
Unit rule
Units declared by whoever prepares the inputs.
Result shape
per_query_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), vector(0.5,0.5). Press Preview fields. The results include query, local_mean, local_sigma, local_effective_n, local_dof, local_count, local_degree, quadratic_condition.

Back to the list

numeric.log_ratio

Computes the logarithm of a ratio of compatible quantities.

Signature
numeric.log_ratio(values, reference)
Arguments
values reference
Shape rule
same_as_input
Unit rule
dimensionless_ratio
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , 50. Press Preview fields. The results include schema, values, n, reference, base, input_shape, method.

Back to the list

numeric.log_response_retransform

Brings the prediction estimated on the logarithmic scale back to the original scale.

Signature
numeric.log_response_retransform(log_predictions)
Arguments
log_predictions
Shape rule
same_as_input
Unit rule
physical_response
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.69314718056,1.09861228867) . In Options use reference=1. Press Preview fields. The results include schema, n, reference, base, median, mean, log_standard_deviation, log_bias_correction.

Back to the list

numeric.matrix_statistics

Summarizes a matrix along the direction specified by the contract.

Signature
numeric.matrix_statistics(values)
Arguments
values
Shape rule
axis_reduction
Unit rule
Field-specific unit.
Result shape
axis_reduced
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include n, mean, median, variance_population, std_population, variance_sample, std_sample, min.

Back to the list

numeric.matrix_svd

Decomposes the matrix into singular values and vectors.

Signature
numeric.matrix_svd(matrix)
Arguments
matrix
Shape rule
two_dimensional
Unit rule
Units declared by whoever prepares the inputs.
Result shape
economy_svd
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) . Press Preview fields. The results include u, singular_values, v, rank, tolerance, condition_number, rows, cols.

Back to the list

numeric.minimize

Searches for parameters that reduce the declared objective, starting from the initial estimate.

Signature
numeric.minimize(callback, initial_parameters)
Arguments
callback initial_parameters
Shape rule
callback_owned
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

Choose the model in the selector and fill in its parameters.

  • quadratic_norm. Sum of the squared differences from center, which defaults to zero if omitted. Use a center with the same dimension as the point.

    Example with synthetic data. Enter, in order, vector(1,2) . Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include x, fval, converged, exitflag, iterations, function_evaluations, solver.

Back to the list

numeric.minimize_1d

Searches for a minimum of a function of one variable in the indicated interval.

Signature
numeric.minimize_1d(callback, interval)
Arguments
callback interval
Shape rule
callback_owned
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

Choose the model in the selector and fill in its parameters.

  • polynomial. Polynomial declared with coefficients, from the highest power down to the constant term.

    Example with synthetic data. Enter, in order, vector(0,3) . Choose the model polynomial . Set coefficients=vector(1,-2,1) in the model fields. Press Preview fields. The results include x, fval, converged, exitflag, iterations, function_evaluations, solver.

Back to the list

numeric.model_export

Extracts the public representation of the model for transfer.

Signature
numeric.model_export(model)
Arguments
model
Shape rule
frozen_model
Unit rule
explicit_axis_units
Result shape
python_octave_latex
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.model_geometry

Queries the geometry supported by the already declared model.

Signature
numeric.model_geometry(model, options)
Arguments
model options
Shape rule
retained_model_geometry
Unit rule
Units declared by whoever prepares the inputs.
Result shape
exact_definition_or_sampled_required
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.model_geometry(record("model","circular_arc","center_x",0,"center_y",0,"radius",1,"angle_start",0,"angle_end",1.5707963267948966),record("domain",vector(0,1),"orientation","parametric")),"status") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.model_inverse

Searches for the input compatible with the requested output in the applicable interval.

Signature
numeric.model_inverse(model, targets, bracket, options)
Arguments
model targets bracket options
Shape rule
bounded_1_to_64_targets
Unit rule
Units declared by whoever prepares the inputs.
Result shape
local_bracket_roots_or_unavailable
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.model_inverse(record("kind","linear","parameters",vector(1,2)),3,vector(0,3),record("domain",vector(0,4))),"roots") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.model_query

Queries a stored model using the references and requests of the contract.

Signature
numeric.model_query(model, query, options)
Arguments
model query options
Shape rule
bounded_scalar_queries
Unit rule
Units declared by whoever prepares the inputs.
Result shape
retained_query_derivatives_and_flags
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.model_query(record("kind","linear","parameters",vector(1,2)),1,record("domain",vector(0,4))),"points") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.model_state_decode

Decodes the state of a model through the compatible public representation.

Signature
numeric.model_state_decode(saved_json)
Arguments
saved_json
Shape rule
bounded_saved_model_bytes
Unit rule
Units declared by whoever prepares the inputs.
Result shape
decoded_model_state
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, @text:{"kind":"linear","parameters":[1,2]} . Press Preview fields. The results include kind, parameters.

Use the exact JSON text of a state saved by a model exporter, or the stream with the exact uint8 bytes. An ordinary numeric vector does not represent a state file.

Back to the list

numeric.nested_f_test

Compares two nested models with an F ratio. Use the same data and check the assumptions on the residuals.

Signature
numeric.nested_f_test(plan)
Arguments
plan
Shape rule
bounded_CORE_nested_F_plan
Unit rule
explicit_CORE_plan
Result shape
nested_F_upper_tail_probability
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.nonlinear_evaluate

Evaluates the curve of a nonlinear model with parameters already chosen.

Signature
numeric.nonlinear_evaluate(model, predictors)
Arguments
model predictors
Shape rule
query_rows
Unit rule
Units declared by whoever prepares the inputs.
Result shape
predictions_and_optional_jacobian
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.nonlinear_evaluate(record("kind","linear","parameters",vector(1,2)),vector(0,1,2,3)),"predicted") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.nonlinear_fit

Estimates the model parameters from the paired x and y points and the initial parameters.

Signature
numeric.nonlinear_fit(model, x, y, initial_parameters)
Arguments
model x y initial_parameters
Shape rule
model_owned
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

Choose the model in the selector and fill in its parameters.

  • linear. Straight line (intercept + slope × x). Provide intercept and slope in this order.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(3.5,4.4,5.3,6.2,7.1,8,8.9,9.8), vector(1.8,2.8). Choose the model linear. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • polynomial_fit. Polynomial for curve fitting. The number of initial values determines the degree. The coefficients are ordered from the highest power down to the constant.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(2,3.08,4.52,6.32,8.48,11,13.88,17.12), vector(2,0.8,1). Choose the model polynomial_fit. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • gaussian. Gaussian profile with amplitude, center, non-zero width and offset, in this order.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(0.453973965868,1.09470228854,2.22091536603,3.12683294019,2.91786557333,1.81822252171,0.817772739303,0.351216600088), vector(2.8,1.5,0.5,0.2). Choose the model gaussian. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • exponential. Profile amplitude × exp(rate × x) + offset. Use amplitude, rate and offset in this order.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(2.63746150616,2.45229807415,2.28807284217,2.1424181277,2.01323398473,1.89865792823,1.79703808217,1.70690936392), vector(1.8,-0.3,1). Choose the model exponential. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • expression. Expression with declared symbols. In the one-parameter case use, for example, expression=”s*x” and parameter_ids=”s”.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(1.5,2.4,3.3,4.2,5.1,6,6.9,7.8), vector(2.8). Choose the model expression. Set expression="s*x", parameter_ids="s" in the model fields. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

  • power_law. Power law: scale × x raised to an exponent. The initial values are scale and exponent. The retained abscissas must be positive.

    Example with synthetic data. Enter, in order, vector(0.5,0.8,1.1,1.4,1.7,2,2.3,2.6), vector(1.06066017178,2.1466252584,3.46106919896,4.9695070178,6.64958645331,8.48528137424,10.4643681128,12.5771220873), vector(2.8,1.4). Choose the model power_law. Press Preview fields. The results include parameters, predicted, residuals, weighted_residuals, objective, sse, rss, rmse.

Back to the list

numeric.normal_cdf

Returns the cumulative probability of the normal distribution.

Signature
numeric.normal_cdf(x, mean, scale)
Arguments
x mean scale
Shape rule
equal_shape_or_scalar
Unit rule
Dimensionless output.
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), 2, 2. Press Preview fields. The results include values.

Back to the list

numeric.one_sided

Builds the spectral representation on non-negative frequencies according to the declared convention.

Signature
numeric.one_sided(real, imaginary)
Arguments
real imaginary
Shape rule
same_length
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include real, imaginary, factor, indices, nfft, bin_count, scaling, has_nyquist.

Back to the list

numeric.one_way_anova

Comparison of group means.

Signature
numeric.one_way_anova(values, groups)
Arguments
values groups
Shape rule
same_length
Unit rule
Field-specific unit.
Result shape
group_summaries_and_test
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,5,6,7,10,11,12) , vector(1,1,1,2,2,2,3,3,3). Press Preview fields. The results include method, n_input, n_valid, n_nonfinite, group_count, group_names.item1, group_names.item2, group_names.item3.

Back to the list

numeric.parameter_uncertainty

Quantifies the uncertainty of the estimated parameters, in the units appropriate to each parameter.

Signature
numeric.parameter_uncertainty(plan)
Arguments
plan
Shape rule
free_parameter_covariance_1_to_256
Unit rule
explicit_CORE_plan
Result shape
free_parameter_correlation_and_marginal_intervals
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

Back to the list

numeric.pca_summary

Components and explained share.

Signature
numeric.pca_summary(singular_values, observation_count)
Arguments
singular_values observation_count
Shape rule
descending_svd_components
Unit rule
source_or_standardized_units
Result shape
component_columns
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include n, singular_value, component_variance, explained_ratio, cumulative_ratio, component_index, component_count, total_component_variance.

Back to the list

numeric.point_sequence_order

Sorts the points according to the declared axis or operating criterion.

Signature
numeric.point_sequence_order(points)
Arguments
points
Shape rule
Nx2_or_Nx3_2_to_4096
Unit rule
caller_owned_metric
Result shape
permutation_and_exact_points
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,0,1,1,1),4,2) . Press Preview fields. The results include permutation, inverse_permutation, points, policy, algorithm, changed_count, closed_endpoint_preserved, start_index.

Back to the list

numeric.polar_coordinates

Computes magnitude and angle from the Cartesian components.

Signature
numeric.polar_coordinates(first_coordinate, second_coordinate)
Arguments
first_coordinate second_coordinate
Shape rule
paired_vectors
Unit rule
explicit_frame
Result shape
paired_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include theta, radius, points, angle_undefined, frame.origin, frame.theta_zero, frame.clockwise, frame.angle_unit.

Back to the list

numeric.polynomial_evaluate

Evaluates a polynomial at the requested points.

Signature
numeric.polynomial_evaluate(model, target_x)
Arguments
model target_x
Shape rule
model_evaluation
Unit rule
Units declared by whoever prepares the inputs.
Result shape
target_vector
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

In-cell example to evaluate a polynomial with known coefficients.

Back to the list

numeric.polynomial_fit

Estimates the coefficients for the requested degree. Check the coverage of the abscissas.

Signature
numeric.polynomial_fit(x, y, degree, weights)
Arguments
x y degree weights
Shape rule
same_length_xy
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model_and_residuals
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4), vector(1.1,2.7,5.2,7.5,8.6), 2, vector(1,1,1,1,1). Press Preview fields. The results include predicted, residuals, weighted_residuals, objective, sse, rss, rmse, residual_rmse.

Back to the list

numeric.polynomial_gls

Estimates the polynomial using the error covariance structure.

Signature
numeric.polynomial_gls(x, y, degree, covariance)
Arguments
x y degree covariance
Shape rule
matching_rows_square_covariance
Unit rule
explicit_covariance_in_squared_response_units
Result shape
physical_and_scaled_polynomial_with_gls_summary
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Provide a square symmetric covariance aligned with the observations. For the absolute exercise, use a 4 × 4 identity matrix. The calculation from the Scripts panel succeeds. The guided Job rejects the declaration covariance_unit or asks for it when it is missing.

Back to the list

numeric.positive_translation

Derives the shift needed to handle a positive domain.

Signature
numeric.positive_translation(values)
Arguments
values
Shape rule
same_as_input
Unit rule
Keep the relevant unit.
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include values, mode, delta, margin, original_bounds, transformed_bounds, algorithm, forward.

Back to the list

numeric.power_level

Expresses the power as a referenced level, according to the provider convention.

Signature
numeric.power_level(power)
Arguments
power
Shape rule
same_as_input
Unit rule
Units declared by whoever prepares the inputs.
Result shape
same_as_input
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 . Press Preview fields. The results include power, root_power, level_db, reference_rms, zero_policy.

Back to the list

numeric.prediction_uncertainty

Quantifies the prediction uncertainty at the requested abscissas.

Signature
numeric.prediction_uncertainty(model, predictors, plan)
Arguments
model predictors plan
Shape rule
captured_model_and_CORE_prediction_plan
Unit rule
explicit_CORE_plan
Result shape
pointwise_response_intervals_and_actual_availability
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Start from the Dataset fit and the public inference plans. In the panel you can use the operation when all operands are present, with the result kept in the required public form. The example runnable from the Worksheet uses the Scripts tab.

The calculation requires a single statistical fit result with preserved identity, the model with the same parameters and the new X values in the same unit.

Back to the list

numeric.propagate_uncertainty

Propagates the uncertainty of the inputs to the result using the declared dependencies.

Signature
numeric.propagate_uncertainty(jacobian, uncertainty)
Arguments
jacobian uncertainty
Shape rule
compatible_matrix
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector_or_matrix
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include covariance, standard_uncertainty, jacobian, input_covariance, method, input_kind, input_count, output_count.

Back to the list

numeric.pulse_timing

Derives the characteristic times of a pulse according to thresholds and sampling.

Signature
numeric.pulse_timing(rising, falling)
Arguments
rising falling
Shape rule
finite_nondecreasing
Unit rule
seconds
Result shape
bounded_timing_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Physical durations require crossings in s, and window metrics require dimensionless coefficients and a positive sampling frequency. See the check on units and contracts.

Back to the list

numeric.quantiles

Estimates the values associated with the requested cumulative probabilities.

Signature
numeric.quantiles(values, probabilities)
Arguments
values probabilities
Shape rule
value_and_probability_vectors
Unit rule
Keep the relevant unit.
Result shape
probability_vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , vector(0.25,0.5,0.75). Press Preview fields. The results include probabilities, quantiles, n, definition.

Back to the list

numeric.rational_domain

Identifies the domain of a rational model and the constraints related to the denominator.

Signature
numeric.rational_domain(model, domain)
Arguments
model domain
Shape rule
two_bounds
Unit rule
physical
Result shape
bounded_pole_and_domain_diagnostics
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.rational_evaluate

Evaluates the ratio of polynomials, avoiding the domain excluded by the denominator.

Signature
numeric.rational_evaluate(model, x, options)
Arguments
model x options
Shape rule
finite_query
Unit rule
physical
Result shape
predictions_derivatives_domain_receipt
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.rational_fit

Estimates numerator and denominator of a rational model according to the requested degrees.

Signature
numeric.rational_fit(model, x, y, options)
Arguments
model x y options
Shape rule
paired_observations
Unit rule
physical
Result shape
physical_model_and_existing_solver_facts
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.rational_model_compose

Composes the representation of the rational model from its recipe.

Signature
numeric.rational_model_compose(recipe)
Arguments
recipe
Shape rule
data_only
Unit rule
dimensional
Result shape
physical_rational_declaration
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a rational recipe with numerator, denominator and coordinates. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.rational_model_restore

Restores a compatible rational model from its state.

Signature
numeric.rational_model_restore(state)
Arguments
state
Shape rule
retained_state
Unit rule
physical
Result shape
validated_rational_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Requires the public state produced by rational_model_state from an actual rational model. Keep schema, coefficients and metadata.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.rational_model_state

Extracts the state representation of the rational model.

Signature
numeric.rational_model_state(model)
Arguments
model
Shape rule
retained_model
Unit rule
physical
Result shape
versioned_rational_state
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.rational_residuals

Computes the residual with respect to the estimated rational response.

Signature
numeric.rational_residuals(model, x, y, options)
Arguments
model x y options
Shape rule
finite_paired_observations
Unit rule
physical
Result shape
descriptive_physical_residuals_and_guard_receipt
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.reduce_accumulate

Performs a cumulative reduction, keeping one result per expected position.

Signature
numeric.reduce_accumulate(state, values)
Arguments
state values
Shape rule
composable
Unit rule
Field-specific unit.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, record("count",3,"sum",6,"min",1,"max",3,"mean",2) , vector(4,5). Press Preview fields. The results include count, sum, min, max, mean.

Back to the list

numeric.reduce_summary

Reduces a series to summary statistics.

Signature
numeric.reduce_summary(values)
Arguments
values
Shape rule
axis_reduction
Unit rule
Field-specific unit.
Result shape
scalar_or_axis_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include count, sum, mean, min, max, requested_dimension, input_shape, output_shape.

Back to the list

numeric.replicate_summary

Summarizes replicated observations, taking the group structure into account.

Signature
numeric.replicate_summary(values, source_ids)
Arguments
values source_ids
Shape rule
coordinate_rows_and_curve_columns
Unit rule
Units declared by whoever prepares the inputs.
Result shape
per_coordinate_vectors_and_common_counts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,4),1,4) , vector(1,1,2,2). In Options use mode="labelled_traces_anova" sampling_model="independent_traces". Press Preview fields. The results include y_mean, y_median, y_std, y_sem, sigma_within, sigma_between, sigma_total, n.

Back to the list

numeric.resample_indices

Builds the resampling indices according to the requested form and criterion.

Signature
numeric.resample_indices(population_size, draw_count, replicates, seed)
Arguments
population_size draw_count replicates seed
Shape rule
scalar_parameters
Unit rule
Dimensionless output.
Result shape
replicates_by_draw_count
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 25, 31. Press Preview fields. The results include indices, population_size, draw_count, replicates, seed, next_seed, replace, generator.

Back to the list

numeric.resample_uniform

Builds a new uniformly stepped sequence.

Signature
numeric.resample_uniform(x, y, step)
Arguments
x y step
Shape rule
same_length_xy
Unit rule
preserve_y
Result shape
generated_vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75), vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1), 2. Press Preview fields. The results include x, y, step, start, stop_requested, stop_actual, n_source, n_output.

Back to the list

numeric.resampling_summary

Summarizes input, grid and result of the resampling.

Signature
numeric.resampling_summary(distribution, observed)
Arguments
distribution observed
Shape rule
observations
Unit rule
Field-specific unit.
Result shape
resampling_summary
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include method, replicates, estimate, confidence, alternative, ci_lower, ci_upper, p_value.

Back to the list

numeric.residual_metrics

Summarizes the residuals between measurements and model with goodness-of-fit metrics.

Signature
numeric.residual_metrics(observed, predicted)
Arguments
observed predicted
Shape rule
same_length
Unit rule
Field-specific unit.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include n, sse, mse, rmse, mae, max_abs_error, r2, response_variance.

Back to the list

numeric.residual_sequence

Returns the paired residuals in series order.

Signature
numeric.residual_sequence(residuals, ordering_keys)
Arguments
residuals ordering_keys
Shape rule
same_length
Unit rule
dimensionless
Result shape
bounded
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,-1,2,-2,3,-3) , empty(). In Options use ordering="input" max_lag=2. Press Preview fields. The results include numeric_api, operation, schema, input_count, n, omitted_count, nonfinite_policy, ordering.

Alternative test in Cell & Formula. Enter =field(numeric.residual_sequence(vector(1,-1,2,-2,3,-3),empty(),record("ordering","input","max_lag",2)),"n") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.root_find

Searches for a zero of the model with the indicated initialization. Check the residual and the convergence status.

Signature
numeric.root_find(callback, initial_value)
Arguments
callback initial_value
Shape rule
callback_owned
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

Choose the model in the selector and fill in its parameters.

  • polynomial. Polynomial declared with coefficients, from the highest power down to the constant term.

    Example with synthetic data. Enter, in order, 1.5 . Choose the model polynomial . Set coefficients=vector(1,-2) in the model fields. Press Preview fields. The results include root, fval, converged, exitflag, iterations, function_evaluations, solver.

Back to the list

numeric.signal_asd

Derives the amplitude spectral density. Check the normalization and the sampling frequency.

Signature
numeric.signal_asd(signal, sample_rate)
Arguments
signal sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_coherence

Estimates the coherence between two paired signals as a function of frequency.

Signature
numeric.signal_coherence(first, second, sample_rate)
Arguments
first second sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_correlation

Computes the time correlation over the allowed lags.

Signature
numeric.signal_correlation(first, second)
Arguments
first second
Shape rule
finite_sequences
Unit rule
normalization_dependent
Result shape
lag_vectors_and_bounded_peak_facts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include value_real, value_imaginary, lags, delay_samples, delay_seconds, n, n_x, n_y.

Back to the list

numeric.signal_cross_psd

Estimates the cross spectral density between two sequences.

Signature
numeric.signal_cross_psd(first, second, sample_rate)
Arguments
first second sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_frf_h1

Computes the H1 estimator of the frequency response.

Signature
numeric.signal_frf_h1(first, second, sample_rate)
Arguments
first second sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_frf_h2

Computes the H2 estimator of the frequency response.

Signature
numeric.signal_frf_h2(first, second, sample_rate)
Arguments
first second sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_periodogram

Estimates the power spectral density with the periodogram.

Signature
numeric.signal_periodogram(signal, sample_rate)
Arguments
signal sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.signal_snr

Computes the signal-to-noise ratio from the pair of compatible inputs.

Signature
numeric.signal_snr(signal, noise)
Arguments
signal noise
Shape rule
equal_vectors
Unit rule
explicit_response
Result shape
bounded_scalar_facts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include n, snr_db, signal_energy, noise_energy, signal_zero, noise_zero, method.

Back to the list

numeric.signal_spectrum_quality

Estimates spectral characteristics of signal, harmonics and noise.

Signature
numeric.signal_spectrum_quality(signal, sample_rate)
Arguments
signal sample_rate
Shape rule
real_vector_and_positive_rate
Unit rule
explicit_response
Result shape
scalar_facts_and_ordered_harmonics
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1) , 4. In Options use fundamental_hz=1. Press Preview fields. The results include n, sample_rate, fundamental_hz, fundamental_bin, harmonic_orders, method, normalization, fundamental_power.

Back to the list

numeric.signal_summary

Returns summary statistics of the signal in the sample domain.

Signature
numeric.signal_summary(values)
Arguments
values
Shape rule
nonempty_finite_real_or_complex
Unit rule
Units declared by whoever prepares the inputs.
Result shape
bounded_descriptive_facts
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include n, rms, peak, peak_to_peak, crest_factor, dc_real, dc_imaginary, input_kind.

Back to the list

numeric.signal_welch

Estimates an average spectral density over overlapping windowed segments.

Signature
numeric.signal_welch(signal, sample_rate)
Arguments
signal sample_rate
Shape rule
finite_sequences
Unit rule
estimator_dependent
Result shape
spectral_vectors_and_bounded_estimator_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Use equally spaced samples, a positive sampling frequency and, for two-signal functions, vectors of equal length. Welch requires a window of at least four coefficients if given as a length. With several bins, the Numeric guided adapter required the column-wise statistical representation. See the tested settings and paths.

Back to the list

numeric.smooth

Estimates a smoothed series according to the available method and window.

Signature
numeric.smooth(x, y)
Arguments
x y
Shape rule
same_length_xy
Unit rule
preserve_y
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include x, y, residuals, method, window, degree, endpoint_policy, original_count.

Back to the list

numeric.spectral_features

Derives descriptors from the distribution of the quantity over frequency.

Signature
numeric.spectral_features(frequency, values)
Arguments
frequency values
Shape rule
matched_vectors_min_3
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalars_and_distribution_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include frequency, source_value, power_equivalent, normalized_power, cumulative_power, relative_power_db, quantile_definition, input_semantics.

Back to the list

numeric.spline_create

Builds the spline representation from the knots and samples.

Signature
numeric.spline_create(x, y)
Arguments
x y
Shape rule
same_length_xy
Unit rule
Units declared by whoever prepares the inputs.
Result shape
model
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) , vector(2,3,2,1,2,3,2,1,2,3,2,1,2,3,2,1). Press Preview fields. The results include model_type, method, breaks, coefficients, pieces, order, dimension, x_min.

Back to the list

numeric.spline_evaluate

Evaluates the spline at the requested abscissas.

Signature
numeric.spline_evaluate(model, target_x)
Arguments
model target_x
Shape rule
model_evaluation
Unit rule
Units declared by whoever prepares the inputs.
Result shape
target_vector
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.spline_evaluate(record("breaks",vector(0,1,2),"coefficients",matrix(vector(2,1,2,3),2,2),"pieces",2,"order",2,"dimension",1),vector(0,1,2)),"values") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.spline_integral

Integrates the spline within the allowed bounds.

Signature
numeric.spline_integral(model, lower, upper)
Arguments
model lower upper
Shape rule
scalar
Unit rule
multiply
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

Alternative test in Cell & Formula. Enter =field(numeric.spline_integral(record("breaks",vector(0,1,2),"coefficients",matrix(vector(2,1,2,3),2,2),"pieces",2,"order",2,"dimension",1),0,2),"value") and use Apply. The result is verified in the sheet with the indicated source.

Back to the list

numeric.statistics

Counts, position and dispersion.

Signature
numeric.statistics(values)
Arguments
values
Shape rule
vector
Unit rule
Field-specific unit.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example of guided operation. values = B1:B16, field mean. Result: 2 V.

Back to the list

numeric.statistics_summary

Returns a structured summary of position and dispersion.

Signature
numeric.statistics_summary(values)
Arguments
values
Shape rule
vector
Unit rule
Field-specific unit.
Result shape
bounded_scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include total_count, finite_count, nan_count, positive_inf_count, negative_inf_count, schema, minimum, maximum.

Back to the list

numeric.student_t_cdf

Returns the cumulative probability of Student’s t at the chosen degrees of freedom.

Signature
numeric.student_t_cdf(t, degrees_of_freedom)
Arguments
t degrees_of_freedom
Shape rule
equal_shape_or_scalar
Unit rule
Dimensionless output.
Result shape
common_shape
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , 2. Press Preview fields. The results include values.

Back to the list

numeric.student_t_quantile

Returns the quantile of Student’s t for a given probability and degrees of freedom.

Signature
numeric.student_t_quantile(probability, degrees_of_freedom)
Arguments
probability degrees_of_freedom
Shape rule
scalar_parameters
Unit rule
Dimensionless output.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 0.5 , 2. Press Preview fields. The results include values, probability, degrees_of_freedom.

Back to the list

numeric.surface_evaluate

Evaluates the already parameterized surface at the requested points.

Signature
numeric.surface_evaluate(model, coordinates, options)
Arguments
model coordinates options
Shape rule
Nx2_query_points
Unit rule
physical
Result shape
physical_xyz_and_domain_flags
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.surface_fit

Estimates a surface model from coordinates and responses.

Signature
numeric.surface_fit(model, x, y, z, options)
Arguments
model x y z options
Shape rule
explicit_points_or_grid_yx
Unit rule
physical
Result shape
model_residuals_and_covariance
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.surface_grid

Evaluates or represents the surface on a coordinate grid.

Signature
numeric.surface_grid(model, x, y, options)
Arguments
model x y options
Shape rule
explicit_grid_axes
Unit rule
physical
Result shape
Y_by_X_surface_samples
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.surface_model_compose

Composes a surface model with the parameters expected by the family.

Signature
numeric.surface_model_compose(recipe)
Arguments
recipe
Shape rule
data_only
Unit rule
dimensional
Result shape
physical_surface_declaration
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Uses a surface recipe with coordinates, basis functions and parameters. In Functions enter the operand as record(...) following exactly the names and types of the contract. The test with a generic record was refused before any fields were produced.

Back to the list

numeric.surface_model_restore

Restores a surface model from the compatible state.

Signature
numeric.surface_model_restore(state)
Arguments
state
Shape rule
retained_surface_state
Unit rule
physical
Result shape
validated_physical_surface_model
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Requires the public state produced by surface_model_state from an actual surface model. Keep schema, basis functions, coefficients and coordinates.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.surface_model_state

Extracts the surface state in reusable form.

Signature
numeric.surface_model_state(model)
Arguments
model
Shape rule
retained_surface
Unit rule
physical
Result shape
versioned_physical_surface_state
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.surface_residuals

Computes the residuals between the surface and the paired observations.

Signature
numeric.surface_residuals(model, x, y, z, options)
Arguments
model x y z options
Shape rule
explicit_points_or_grid_yx
Unit rule
physical
Result shape
descriptive_physical_residuals
Provider
math.numeric · NUMERIC_API_v1

The signature requires model. In this version the editor does not expose the model field by name, nor a declarative selector for this entry. See field correspondence.

The executable flow from Scripts uses the declaration and the public state of the model, with the coordinates and options required by this function.

Back to the list

numeric.uniform_grid

Creates equally spaced abscissas from the declared constraints.

Signature
numeric.uniform_grid(start, stop, spacing)
Arguments
start stop spacing
Shape rule
scalar_parameters
Unit rule
Units declared by whoever prepares the inputs.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2, 2, 2. Press Preview fields. The results include x, n, step, start, stop_requested, stop_actual, mode.

Back to the list

numeric.unwrap

Corrects phase discontinuities caused by a jump of one period.

Signature
numeric.unwrap(phase)
Arguments
phase
Shape rule
vector
Unit rule
Keep the relevant unit.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 . Press Preview fields. The results include values, period.

Back to the list

numeric.validate_monotonic

Checks the order of the sequence before using it as a grid.

Signature
numeric.validate_monotonic(x)
Arguments
x
Shape rule
vector
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0.25,0.5,0.75,1,1.25,1.5,1.75,2,2.25,2.5,2.75,3,3.25,3.5,3.75) . Press Preview fields. The results include n, monotonic, strict_monotonic, direction, duplicate_count.

Back to the list

numeric.vector_normalize

Scales the vector according to the norm required by the contract.

Signature
numeric.vector_normalize(values)
Arguments
values
Shape rule
vector
Unit rule
Dimensionless output.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) . Press Preview fields. The results include values, norm, center, n, method.

Back to the list

numeric.vector_similarity

Compares aligned vectors with the indicated measure.

Signature
numeric.vector_similarity(left, right)
Arguments
left right
Shape rule
same_length
Unit rule
Dimensionless output.
Result shape
scalar
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , vector(1,2,3,4,5,6,7,8). Press Preview fields. The results include score, cosine, n, method.

Back to the list

numeric.weighted_quantiles

Estimates the quantiles of the weighted empirical distribution.

Signature
numeric.weighted_quantiles(values, weights, probabilities)
Arguments
values weights probabilities
Shape rule
same_length_values_weights
Unit rule
Keep the relevant unit.
Result shape
probability_vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8), vector(1,2,1,2,1,2,1,2), vector(0.25,0.5,0.75). Press Preview fields. The results include probabilities, quantiles, n_total, n_input, n_valid, n_nonfinite, n_zero_weight, n_positive_weight.

Back to the list

numeric.weighted_statistics

Computes statistics assigning the specified weights to the observations.

Signature
numeric.weighted_statistics(values, weights)
Arguments
values weights
Shape rule
same_length
Unit rule
Field-specific unit.
Result shape
scalar_fields
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3,4,5,6,7,8) , vector(1,2,1,2,1,2,1,2). Press Preview fields. The results include n_total, n_input, n_valid, n_nonfinite, n_zero_weight, n_positive_weight, n_positive, sum_weights.

Back to the list

numeric.welch_aggregate

Summarizes segment-wise spectral contributions according to the Welch convention.

Signature
numeric.welch_aggregate(sum_psd, sum_amplitude)
Arguments
sum_psd sum_amplitude
Shape rule
matched_vectors_min_2
Unit rule
Units declared by whoever prepares the inputs.
Result shape
scalars_and_spectral_vectors
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(2,8,1) , vector(0.5,2,0.25). In Options use window_count=2 frequency_step_hz=1 enbw_sum_hz=2. Press Preview fields. The results include psd, asd, mean_amplitude, psd_db, frequency, window_count, bin_count, df.

Back to the list

numeric.window

Builds the weights of a window for the requested length.

Signature
numeric.window(name, length)
Arguments
name length
Shape rule
scalar_parameters
Unit rule
Dimensionless output.
Result shape
vector
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, "hann" , 8. In Options use sampling="periodic". Press Preview fields. The results include values, name, length, sampling, power_sum, coherent_gain, rms_gain, enbw_bins.

Contract values

rectangular
In name, use rectangular for weights all equal to one.
hann
In name, use hann for a raised-cosine window that goes to zero at both ends symmetrically.
hamming
In name, use hamming for a raised-cosine window with a non-zero end weight.
blackman
In name, use blackman for the three-term profile with attenuated side lobes.
blackman_harris
In name, use blackman_harris for the four-term version, with stronger attenuation and a wider main lobe.
flat_top
In name, use flat_top if the accuracy of the amplitude estimate near the peak of a bin matters.
symmetric
In Options, use sampling=”symmetric” for symmetry around the center of the samples. This is the default.
periodic
In Options, use sampling=”periodic” for the periodic form, suited to repeating the block in the FFT representation.

Back to the list

numeric.window_metrics

Describes the window properties, including the equivalent response when exposed.

Signature
numeric.window_metrics(window, sample_rate)
Arguments
window sample_rate
Shape rule
finite_real_nonzero_sum
Unit rule
dimensionless_and_hz
Result shape
bounded_window_facts
Provider
math.numeric · NUMERIC_API_v1

In Functions select this entry. Prepare the operands in the indicated form, then use Preview fields. Choose the field from the completed Job and check form, unit and destination before Apply result.

Physical durations require crossings in s, and window metrics require dimensionless coefficients and a positive sampling frequency. See the check on units and contracts.

Back to the list