Foundation operations

Consult the contracts of the Foundation operations and check the declared inputs for guided calculations in the GX-TXT Worksheet.

How to use this family

Open the exact entry in the Functions browser. A family groups several contracts. Operations with a declarative model show the allowed models in the selector. Results can include structured fields, coordinates, matrices, states and diagnostics. Before applying, check the field with Preview fields. A triangulated form, a tensor or a system of equations requires the inputs of the specific contract.

Function index

numeric.foundation.calculus.directional

Computes the change of the field along the indicated direction.

Signature
numeric.foundation.calculus.directional(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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, 2 , 1. Choose the model polynomial . Set coefficients=vector(1,-2,1) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

  • 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) , vector(1,0). Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.gradient

Estimates the direction and rate of change of the field with respect to the coordinates.

Signature
numeric.foundation.calculus.gradient(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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, 2 , 1. Choose the model polynomial . Set coefficients=vector(1,-2,1) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

  • 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) , vector(1,0). Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.gradient_grid

Computes a partial derivative per axis at the grid nodes.

Signature
numeric.foundation.calculus.gradient_grid(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.calculus.hessian

Computes the matrix of second derivatives of the model.

Signature
numeric.foundation.calculus.hessian(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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, 2 , 1. Choose the model polynomial . Set coefficients=vector(1,-2,1) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

  • 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) , vector(1,0). Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.integrate2

Integrates a sampled field over the two axes of the grid.

Signature
numeric.foundation.calculus.integrate2(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.calculus.integrate3

Integrates a sampled field over the three axes of the grid.

Signature
numeric.foundation.calculus.integrate3(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.calculus.jacobian

Computes the matrix of first derivatives of the components.

Signature
numeric.foundation.calculus.jacobian(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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(1,2) , vector(1,0). Choose the model polynomial . Set coefficients=vector(1,-2,1) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

  • 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) , vector(1,0). Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

  • linear_system. System with matrix and target. The residual is the matrix times the state minus the target, optionally multiplied by the continuation parameter.

    Example with synthetic data. Enter, in order, vector(1,2) , vector(1,0). Choose the model linear_system . Set matrix=matrix(vector(1,0,0,1),2,2), target=vector(1,2) in the model fields. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.line_integral

Integrates the vector field projected on the oriented path.

Signature
numeric.foundation.calculus.line_integral(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.line_scalar_integral

Integrates the scalar values with respect to path length.

Signature
numeric.foundation.calculus.line_scalar_integral(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , vector(2,3,3,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.surface_flux

Integrates the normal component over the surface. The orientation of the faces determines the sign.

Signature
numeric.foundation.calculus.surface_flux(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,0,0,0,1,0,0,0,1,1,2,3),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.surface_integral

Integrates the scalar value over the face areas.

Signature
numeric.foundation.calculus.surface_integral(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), vector(2,3,3,2), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.calculus.weighted_integral

Integrates the field multiplied by the weights sampled on the same grid.

Signature
numeric.foundation.calculus.weighted_integral(axes, values, extra, options)
Arguments
axes values extra
Input shape
numeric arrays or callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.constrained.solve

Minimizes the declarative objective with bounds and constraints. Start from a point compatible with the form of the conditions.

Signature
numeric.foundation.constrained.solve(objective, initial, constraints, options)
Arguments
objective initial constraints
Input shape
execution-scoped callback and constraints
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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. The calculation requires the Octave optim package. The example uses explicit linear constraints in addition to lower and upper bounds. Enter, in order, vector(0,1) , record("lower",vector(-3,-4),"upper",vector(3,4),"Aeq",matrix(vector(1,0),1,2),"beq",0,"A",matrix(vector(0,1),1,2),"b",3). Choose the model quadratic_norm. Set center=vector(0,0) in the model fields. Press Preview fields. The results include point, objective, status, converged, method, iterations, function_evaluations, equality_residual.

Back to the list

numeric.foundation.equations.continuation

Follows a solution of the system while the parameter varies.

Signature
numeric.foundation.equations.continuation(residual, initial, parameters, options)
Arguments
residual initial parameters
Input shape
execution-scoped callback and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • linear_system. System with matrix and target. The residual is the matrix times the state minus the target, optionally multiplied by the continuation parameter.

    Example with synthetic data. Enter, in order, vector(1,2) , vector(0.5,1,1.5). Choose the model linear_system . Set matrix=matrix(vector(1,0,0,1),2,2), target=vector(1,2) in the model fields. Press Preview fields. The results include parameters, solutions, residual_norm, status, converged.

Back to the list

numeric.foundation.equations.multiple_start

Tries several initial conditions to explore the solutions of the system.

Signature
numeric.foundation.equations.multiple_start(residual, initial, parameters, options)
Arguments
residual initial parameters
Input shape
execution-scoped callback and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • linear_system. System with matrix and target. The residual is the matrix times the state minus the target, optionally multiplied by the continuation parameter.

    Example with synthetic data. Enter, in order, matrix(vector(0,0,1,1),2,2) , empty(). Choose the model linear_system . Set matrix=matrix(vector(1,0,0,1),2,2), target=vector(1,2) in the model fields. Press Preview fields. The results include solutions.item1, solutions.item2, residual_norm, status, converged.

Back to the list

numeric.foundation.equations.solve

Searches for a zero of the declared equations from the initial state and returns convergence diagnostics.

Signature
numeric.foundation.equations.solve(residual, initial, parameters, options)
Arguments
residual initial parameters
Input shape
execution-scoped callback and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • linear_system. System with matrix and target. The residual is the matrix times the state minus the target, optionally multiplied by the continuation parameter.

    Example with synthetic data. Enter, in order, vector(1,2) , vector(1,0). Choose the model linear_system . Set matrix=matrix(vector(1,0,0,1),2,2), target=vector(1,2) in the model fields. Press Preview fields. The results include solutions.item1, residual_norm, status, converged.

Back to the list

numeric.foundation.family.align

Aligns the coordinates of several series in a family.

Signature
numeric.foundation.family.align(x, y, target, options)
Arguments
x y target
Input shape
aligned scientific data
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.family.derivative

Estimates the derivative according to the declared variable and method.

Signature
numeric.foundation.family.derivative(x, y, target, options)
Arguments
x y target
Input shape
aligned scientific data
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.family.envelope

Determines an envelope of amplitude or of values, according to the contract.

Signature
numeric.foundation.family.envelope(x, y, target, options)
Arguments
x y target
Input shape
aligned scientific data
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.family.extrema

Finds the extrema of the series and their coordinates.

Signature
numeric.foundation.family.extrema(x, y, target, options)
Arguments
x y target
Input shape
aligned scientific data
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.family.surface

Aligns and organizes the curves of a family in a common indexed representation.

Signature
numeric.foundation.family.surface(x, y, target, options)
Arguments
x y target
Input shape
aligned scientific data
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.geometry.barycentric

Expresses the point as a weighted combination of the simplex vertices.

Signature
numeric.foundation.geometry.barycentric(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(0,0,0,1,0,0,0,1,0),3,3). Press Preview fields. The results include weights, plane_distance.

Back to the list

numeric.foundation.geometry.centroid

Determines the centroid of the described geometry.

Signature
numeric.foundation.geometry.centroid(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) . Press Preview fields. The results include centroid.

Back to the list

numeric.foundation.geometry.delaunay

Computes a Delaunay triangulation of the given points.

Signature
numeric.foundation.geometry.delaunay(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,1.5,1,0,2,0.2,0.6),5,2) . Press Preview fields. The results include simplices.

Back to the list

numeric.foundation.geometry.frame_transform

Transforms coordinates between declared reference frames.

Signature
numeric.foundation.geometry.frame_transform(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), vector(0,0,0), matrix(vector(1,0,0,0,1,0,0,0,1),3,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.geometry.kdtree_query

Searches for neighbors in the point cloud.

Signature
numeric.foundation.geometry.kdtree_query(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3). Press Preview fields. The results include index, distance.

Back to the list

numeric.foundation.geometry.line_fit

Estimates the straight line that represents the three-dimensional points.

Signature
numeric.foundation.geometry.line_fit(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) . Press Preview fields. The results include origin, direction, rms_distance.

Back to the list

numeric.foundation.geometry.mesh_boolean

Applies the indicated set operation to the meshes.

Signature
numeric.foundation.geometry.mesh_boolean(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 left.vtp and right.vtp as two VTK PolyData operands with absolute paths. The closed surfaces overlap. Set a new output path and the union operation. Download the VTK files and follow the path entry.

Back to the list

numeric.foundation.geometry.mesh_remesh

Rebuilds the mesh discretization according to the requested criteria.

Signature
numeric.foundation.geometry.mesh_remesh(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 left.vtp as the mesh, a new output path and iterations=1 as in the example. The examples contain a triangulated surface. Download the VTK files and follow the path entry.

Back to the list

numeric.foundation.geometry.mesh_section

Intersects the mesh with the plane identified by origin and normal.

Signature
numeric.foundation.geometry.mesh_section(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3), vector(0,0,0.2). In Options use normal=vector(0,0,1). Press Preview fields. The results include segments, source_triangle_index, status.

Back to the list

numeric.foundation.geometry.mesh_smooth

Reduces local variations of the mesh according to the available method.

Signature
numeric.foundation.geometry.mesh_smooth(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the VTK PolyData file left.vtp as an operand prefixed with @text:. Set an absolute output path with the extension .vtp and the iteration parameters. Download the VTK files and follow the path entry.

Back to the list

numeric.foundation.geometry.mesh_surface_area

Sums the areas of the triangular faces of the mesh.

Signature
numeric.foundation.geometry.mesh_surface_area(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, empty(), matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include area.

Back to the list

numeric.foundation.geometry.mesh_volume

Estimates the volume enclosed by a closed, consistently oriented mesh.

Signature
numeric.foundation.geometry.mesh_volume(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, empty(), matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include signed_volume, volume.

Back to the list

numeric.foundation.geometry.nearest

Finds the nearest reference point for each query.

Signature
numeric.foundation.geometry.nearest(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3). Press Preview fields. The results include index, distance.

Back to the list

numeric.foundation.geometry.orientation2d

Determines the orientation and any degeneracy of the planar configuration.

Signature
numeric.foundation.geometry.orientation2d(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0), vector(1,0), vector(0,1). Press Preview fields. The results include signed_area_twice, sign.

Back to the list

numeric.foundation.geometry.orientation3d

Determines the orientation of the configuration of four points in space.

Signature
numeric.foundation.geometry.orientation3d(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0,1,0,0,0,1,0,0,0,1) . Press Preview fields. The results include signed_volume_sixfold, sign.

Back to the list

numeric.foundation.geometry.plane_containing_tangent

Builds the plane through the point and the tangent, rotated by the declared angle.

Signature
numeric.foundation.geometry.plane_containing_tangent(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0), vector(1,0,0), 0.2. Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.plane_fit

Estimates the plane from 3D points and returns its normal.

Signature
numeric.foundation.geometry.plane_fit(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0),3,3) . Press Preview fields. The results include origin, normal, rms_distance.

Back to the list

numeric.foundation.geometry.plane_flip

Reverses the orientation of the plane normal.

Signature
numeric.foundation.geometry.plane_flip(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0), vector(0,0,1), vector(1,0,0). Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.plane_frame

Builds a local basis on the plane.

Signature
numeric.foundation.geometry.plane_frame(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0), vector(0,0,1), vector(1,0,0). Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.plane_offset

Shifts the plane along its normal by the requested offset.

Signature
numeric.foundation.geometry.plane_offset(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0), vector(0,0,1), 2. Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.plane_orient

Orients the plane normal according to the requested convention.

Signature
numeric.foundation.geometry.plane_orient(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0) , vector(0,0.4,0.5). Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.plane_three_points

Builds the plane through three non-collinear points.

Signature
numeric.foundation.geometry.plane_three_points(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,0,0), vector(1,0,0), vector(0,1,0). Press Preview fields. The results include origin, normal, u_axis, v_axis.

Back to the list

numeric.foundation.geometry.point_mesh_distance

Measures the minimum distance between a point and a mesh.

Signature
numeric.foundation.geometry.point_mesh_distance(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3), matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include distance, triangle_index.

Back to the list

numeric.foundation.geometry.point_segment_distance

Measures the minimum distance between a point and a finite segment.

Signature
numeric.foundation.geometry.point_segment_distance(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), vector(0,0,0), vector(1,0,0). Press Preview fields. The results include distance, fraction, closest.

Back to the list

numeric.foundation.geometry.point_triangle_distance

Measures the minimum distance between a point and a triangle.

Signature
numeric.foundation.geometry.point_triangle_distance(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3), matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), matrix(vector(1,3,2,1,2,4,1,4,3,2,3,4),4,3). Press Preview fields. The results include distance, triangle_index.

Back to the list

numeric.foundation.geometry.rigid_transform

Transforms the points with a rotation and a translation.

Signature
numeric.foundation.geometry.rigid_transform(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , matrix(vector(1,0,0,2,0,0,1,1,0,1,0,1),4,3). Press Preview fields. The results include rotation, translation, rms_residual.

Back to the list

numeric.foundation.geometry.tetrahedron_volume

Computes the volume from the coordinates of the four vertices.

Signature
numeric.foundation.geometry.tetrahedron_volume(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),1,12) . Press Preview fields. The results include volume.

Back to the list

numeric.foundation.geometry.trajectory_plane_intersections

Finds the plane crossings along the ordered trajectory.

Signature
numeric.foundation.geometry.trajectory_plane_intersections(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3), vector(0.2,0,0), vector(1,0,0). Press Preview fields. The results include points, source_row_pairs, fraction, status.

Back to the list

numeric.foundation.geometry.trajectory_tangent

Estimates the tangent direction along the trajectory.

Signature
numeric.foundation.geometry.trajectory_tangent(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0,0,0,1),4,3) , 2. Press Preview fields. The results include point, tangent, source_row.

Back to the list

numeric.foundation.geometry.triangle_area

Computes the area from the coordinates of the three vertices.

Signature
numeric.foundation.geometry.triangle_area(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,0,0,0,1,0),1,9) . Press Preview fields. The results include area.

Back to the list

numeric.foundation.geometry.volume_slice

Extracts a section of the volumetric field.

Signature
numeric.foundation.geometry.volume_slice(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 @text:/percorso/grid.vti for the volume, vector(0,0,1) for the normal and vector(0,0,1.5) for the point, in the order volume, point, normal. The file contains a VTK scalar grid. Download the VTK files and follow the path entry.

Back to the list

numeric.foundation.geometry.voronoi

Computes the Voronoi neighborhood structure of the given points.

Signature
numeric.foundation.geometry.voronoi(first, second, third, options)
Arguments
first second third
Input shape
geometric points, meshes or files
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,1,0,1.5,1,0,2,0.2,0.6),5,2) . Press Preview fields. The results include vertices, cells.item1, cells.item2, cells.item3, cells.item4, cells.item5, cells.item6.

Back to the list

numeric.foundation.grid.compatible

Checks the compatibility of the coordinates within the set tolerances.

Signature
numeric.foundation.grid.compatible(axes, values, query, options)
Arguments
axes values query
Input shape
regular grid and query points
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.grid.interpolate

Interpolated evaluation at the requested points.

Signature
numeric.foundation.grid.interpolate(axes, values, query, options)
Arguments
axes values query
Input shape
regular grid and query points
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.grid.resample

Resampling on the new coordinates.

Signature
numeric.foundation.grid.resample(axes, values, query, options)
Arguments
axes values query
Input shape
regular grid and query points
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.grid.sample

Samples a field at the indicated points on the grid or in the provider geometry.

Signature
numeric.foundation.grid.sample(axes, values, query, options)
Arguments
axes values query
Input shape
regular grid and query points
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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 the axes as a typed list of monotonic vectors. For a family of curves, provide the x and y coordinates as paired lists. The value dimensions must match the axis lengths in order. See grid, family and field script for the exact shape this operation expects.

Back to the list

numeric.foundation.ode.solve

Integrates the declared differential system over the time abscissas, starting from the initial state.

Signature
numeric.foundation.ode.solve(rhs, time_span, initial_state, options)
Arguments
rhs time_span initial_state
Input shape
execution-scoped callback and numeric state
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • linear_ode. Linear differential equation with matrix and optional offset. The derivative is the matrix times the state plus the offset.

    Example with synthetic data. Enter, in order, vector(0,0.5,1) , vector(1,2). Choose the model linear_ode . Set matrix=matrix(vector(-1,0,0,-2),2,2) in the model fields. Press Preview fields. The results include time, state_real, state_imaginary, success, cancelled, terminated_by_event, output_count, method.

Back to the list

numeric.foundation.scattered.interpolate

Interpolated evaluation at the requested points.

Signature
numeric.foundation.scattered.interpolate(points, values, query, options)
Arguments
points values query
Input shape
point cloud and query points
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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), vector(0,1,1,2), matrix(vector(0.25,0.25),1,2). Press Preview fields. The results include value_real, value_imaginary, outside.

Back to the list

numeric.foundation.sparse.construct

Builds a sparse matrix from row, column and value triplets. Declare the total dimensions.

Signature
numeric.foundation.sparse.construct(sparse_matrix, other, unused, options)
Arguments
sparse_matrix other unused
Input shape
sparse matrix and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,1,2,2,2,4,3,3,8),3,3) , vector(3,3). Press Preview fields. The results include row, column, value_real, value_imaginary, nonzeros, shape.

Back to the list

numeric.foundation.sparse.eigen_subset

Extracts part of the eigenvalue spectrum according to the selector.

Signature
numeric.foundation.sparse.eigen_subset(sparse_matrix, other, unused, options)
Arguments
sparse_matrix other unused
Input shape
sparse matrix and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(2,0,0,0,4,0,0,0,8),3,3) . In Options use count=1 which="lm". Press Preview fields. The results include eigenvalues_real, eigenvalues_imaginary, eigenvectors_real, eigenvectors_imaginary.

Back to the list

numeric.foundation.sparse.least_squares

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

Signature
numeric.foundation.sparse.least_squares(sparse_matrix, other, unused, options)
Arguments
sparse_matrix other unused
Input shape
sparse matrix and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , vector(2,5,1). Press Preview fields. The results include value_real, value_imaginary, residual_norm.

Back to the list

numeric.foundation.sparse.matvec

Multiplies the sparse matrix by a compatible vector.

Signature
numeric.foundation.sparse.matvec(sparse_matrix, other, unused, options)
Arguments
sparse_matrix other unused
Input shape
sparse matrix and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , vector(2,5,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.sparse.solve

Solves the linear system represented by the sparse matrix with the right-hand side.

Signature
numeric.foundation.sparse.solve(sparse_matrix, other, unused, options)
Arguments
sparse_matrix other unused
Input shape
sparse matrix and numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 2 , vector(2,5,1). Press Preview fields. The results include value_real, value_imaginary, residual_norm.

Back to the list

numeric.foundation.special.airy

Evaluates the Airy function or the variant chosen with kind.

Signature
numeric.foundation.special.airy(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 1.5 , 0. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.special.bessel_i

Evaluates the modified Bessel function of the first kind at the indicated order.

Signature
numeric.foundation.special.bessel_i(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.bessel_j

Evaluates the Bessel function of the first kind at the indicated order.

Signature
numeric.foundation.special.bessel_j(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.bessel_k

Evaluates the modified Bessel function of the second kind at the indicated order.

Signature
numeric.foundation.special.bessel_k(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.bessel_y

Evaluates the Bessel function of the second kind at the indicated order.

Signature
numeric.foundation.special.bessel_y(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.beta

Evaluates the beta function for the two given parameters.

Signature
numeric.foundation.special.beta(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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.

Back to the list

numeric.foundation.special.erf

Error function.

Signature
numeric.foundation.special.erf(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example of guided operation. value = 1. The value_real field gives about 0.8427.

Back to the list

numeric.foundation.special.erfc

Complementary error function.

Signature
numeric.foundation.special.erfc(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.exponential_integral

Evaluates the exponential integral in the provider convention.

Signature
numeric.foundation.special.exponential_integral(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.gamma

Evaluates the gamma function. For positive integers it generalizes the shifted factorial.

Signature
numeric.foundation.special.gamma(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.incomplete_beta

Evaluates the incomplete beta with an argument and two shape parameters. The third input is set in Options with third_shape.

Signature
numeric.foundation.special.incomplete_beta(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, 0.5 , 2. In Options use third_shape=3. Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.special.incomplete_gamma

Evaluates the incomplete gamma for value and shape. The tail is defined by the tail option.

Signature
numeric.foundation.special.incomplete_gamma(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.log_gamma

Evaluates the logarithm of the gamma function in the provider convention.

Signature
numeric.foundation.special.log_gamma(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.sinc

Evaluates the sinc function. Check whether the argument is normalized in the chosen convention.

Signature
numeric.foundation.special.sinc(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.spherical_bessel_j

Evaluates the spherical Bessel function of the first kind.

Signature
numeric.foundation.special.spherical_bessel_j(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.special.spherical_bessel_y

Evaluates the spherical Bessel function of the second kind.

Signature
numeric.foundation.special.spherical_bessel_y(value, parameter, unused, options)
Arguments
value parameter unused
Input shape
scalar or numeric array
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

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

Back to the list

numeric.foundation.statistics.bootstrap_ci

Builds an uncertainty interval using bootstrap replicates.

Signature
numeric.foundation.statistics.bootstrap_ci(samples, other, extra, options)
Arguments
samples other extra
Input shape
numeric observations and options
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(2,3,5,8,8,11,13,14) . In Options use seed=31 replicates=120 alpha=0.05. Press Preview fields. The results include estimate, lower, upper, replicates, n_x, n_y, method, alternative.

Back to the list

numeric.foundation.statistics.confidence_interval

Computes confidence limits at the declared level for the model or the statistic.

Signature
numeric.foundation.statistics.confidence_interval(samples, other, extra, options)
Arguments
samples other extra
Input shape
numeric observations and options
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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), vector(2,5,1), 2. Press Preview fields. The results include estimate, lower, upper, confidence, n, standard_error, degrees_of_freedom, method.

Back to the list

numeric.foundation.statistics.covariance_diagnostics

Checks relevant properties of the covariance matrix.

Signature
numeric.foundation.statistics.covariance_diagnostics(samples, other, extra, options)
Arguments
samples other extra
Input shape
real or complex observations by rows; a vector is one variable
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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), vector(2,5,1), 2. Press Preview fields. The results include covariance, eigenvalues, condition_number, rank, covariance_real, covariance_imaginary, eigenvalues_real, eigenvalues_imaginary.

Back to the list

numeric.foundation.statistics.glm

Fits a generalized linear model with declared family and link.

Signature
numeric.foundation.statistics.glm(samples, other, extra, options)
Arguments
samples other extra
Input shape
real design and dimensionless binary or count response
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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,1,5,1,6,1,7),8,2) , vector(1,2,2,3,5,4,6,8). In Options use family="poisson". Press Preview fields. The results include coefficients, fitted_mean, family, link, iterations, converged, score_norm, coefficients_real.

Back to the list

numeric.foundation.statistics.kmeans

Partitions the observations into groups around centroids. Check the scale and the number of groups.

Signature
numeric.foundation.statistics.kmeans(samples, other, extra, options)
Arguments
samples other extra
Input shape
real observation rows; explicit seed and integer clusters
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(0,0,0,1,1,0,10,10,11,10,10,11),6,2) . In Options use seed=31 clusters=2 replicates=3. Press Preview fields. The results include labels, centroids, within_ss, cluster_counts, total_within_ss, n, feature_count, cluster_count.

Back to the list

numeric.foundation.statistics.logistic_regression

Models a binary response with a probability linearly linked to the predictors on the log-odds scale.

Signature
numeric.foundation.statistics.logistic_regression(samples, other, extra, options)
Arguments
samples other extra
Input shape
real design and dimensionless binary response
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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,1,5,1,6,1,7),8,2) , vector(0,1,0,1,0,0,1,1). Press Preview fields. The results include coefficients, probability, iterations, converged, coefficients_real, coefficients_imaginary, n, p.

Back to the list

numeric.foundation.statistics.multiple_testing

Corrects inference when several hypotheses are tested.

Signature
numeric.foundation.statistics.multiple_testing(samples, other, extra, options)
Arguments
samples other extra
Input shape
dimensionless p-values and method option
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0.01,0.04,0.15,0.8) . In Options use method="holm". Press Preview fields. The results include family_size, method, adjusted_p, original_p, hypothesis_index.

Back to the list

numeric.foundation.statistics.partial_correlation

Estimates the association between two series after conditioning on the covariates.

Signature
numeric.foundation.statistics.partial_correlation(samples, other, extra, options)
Arguments
samples other extra
Input shape
aligned real observation vectors and control columns
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(0,1,2,3,4,5,6,7), vector(2,3,5,8,8,11,13,14), vector(0,1,0,1,0,0,1,1). Press Preview fields. The results include correlation, n, variable_count, control_count, covariance_rank, normalization_valid, method.

Back to the list

numeric.foundation.statistics.permutation_test

Builds the reference distribution by permuting the observations according to the test.

Signature
numeric.foundation.statistics.permutation_test(samples, other, extra, options)
Arguments
samples other extra
Input shape
numeric observations and options
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(2,3,5,8,8,11,13,14) , vector(0,1,2,3,4,5,6,7). In Options use seed=31 replicates=120. Press Preview fields. The results include difference, p_value, replicates, n_x, n_y, extreme_count, method, alternative.

Back to the list

numeric.foundation.statistics.robust_location

Estimates location while limiting sensitivity to extreme values.

Signature
numeric.foundation.statistics.robust_location(samples, other, extra, options)
Arguments
samples other extra
Input shape
numeric observations and options
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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), vector(2,5,1), 2. Press Preview fields. The results include location, scale, iterations, method, n, huber_constant, converged, scale_method.

Back to the list

numeric.foundation.statistics.robust_regression

Estimates a relation while reducing the weight of large residuals.

Signature
numeric.foundation.statistics.robust_regression(samples, other, extra, options)
Arguments
samples other extra
Input shape
design matrix and response; optional positive Huber constant
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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,1,5,1,6,1,7),8,2) , vector(2,3,5,8,8,11,13,14). In Options use huber_constant=1.345. Press Preview fields. The results include coefficients, residual, iterations, method, coefficients_real, coefficients_imaginary, residual_real, residual_imaginary.

Back to the list

numeric.foundation.statistics.survival_kaplan_meier

Estimates survival over time taking censored observations into account.

Signature
numeric.foundation.statistics.survival_kaplan_meier(samples, other, extra, options)
Arguments
samples other extra
Input shape
numeric observations and options
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,2,3,4,4,6,7) , vector(0,1,0,1,0,0,1,1). Press Preview fields. The results include method, n, time, survival, at_risk, events, censored.

Back to the list

numeric.foundation.tensor.antisymmetric_part

Extracts the part that changes sign when the indices are swapped.

Signature
numeric.foundation.tensor.antisymmetric_part(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.apply

Applies the matrix tensor to a vector with the number of components required by the columns.

Signature
numeric.foundation.tensor.apply(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , vector(1,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.conjugate_transpose

Conjugate transpose.

Signature
numeric.foundation.tensor.conjugate_transpose(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.contract

Contracts compatible indices and reduces the rank of the result according to the operation.

Signature
numeric.foundation.tensor.contract(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.outer

Outer product.

Signature
numeric.foundation.tensor.outer(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2) , vector(2,3). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.symmetric_part

Extracts the part that is invariant under swapping the indices.

Signature
numeric.foundation.tensor.symmetric_part(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.trace

Trace of the tensor.

Signature
numeric.foundation.tensor.trace(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.tensor.transpose

Swaps rows and columns.

Signature
numeric.foundation.tensor.transpose(tensor, other, unused, options)
Arguments
tensor other unused
Input shape
matrix or tensor
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, matrix(vector(1,2,3,5),2,2) , matrix(vector(1,2,3,5),2,2). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.variational.action

Integrates the action associated with the Lagrangian along the declared values.

Signature
numeric.foundation.variational.action(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • quadratic_lagrangian. Quadratic Lagrangian with mass and stiffness, consistent with the number of coordinates and velocities.

    Example with synthetic data. Enter, in order, vector(0,0.5,1) , vector(0,0.25,1). Choose the model quadratic_lagrangian . Set mass=1, stiffness=1 in the model fields. Press Preview fields. The results include action, density, velocity.

Back to the list

numeric.foundation.variational.constrained

Minimizes the functional with the constraints indicated in the options.

Signature
numeric.foundation.variational.constrained(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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. The calculation requires the Octave optim package. The example uses explicit linear constraints in addition to lower and upper bounds. Enter, in order, 0 , vector(0,1). Choose the model quadratic_norm. Set center=vector(0,0) in the model fields. In Options use constraints=record("lower",vector(-3,-4),"upper",vector(3,4),"Aeq",matrix(vector(1,0),1,2),"beq",0,"A",matrix(vector(0,1),1,2),"b",3). Press Preview fields. The results include point, objective, status, converged, method, iterations, function_evaluations, equality_residual.

Back to the list

numeric.foundation.variational.euler_lagrange_residual

Computes the residual of the Euler–Lagrange condition.

Signature
numeric.foundation.variational.euler_lagrange_residual(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • quadratic_lagrangian. Quadratic Lagrangian with mass and stiffness, consistent with the number of coordinates and velocities.

    Example with synthetic data. Enter, in order, vector(0,0.5,1) , vector(0,0.25,1). Choose the model quadratic_lagrangian . Set mass=1, stiffness=1 in the model fields. Press Preview fields. The results include residual, velocity, momentum.

Back to the list

numeric.foundation.variational.first_variation

Computes the first variation of the functional in the declared direction.

Signature
numeric.foundation.variational.first_variation(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
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) , vector(1,0). Choose the model quadratic_norm . Set center=vector(0,0) in the model fields. Press Preview fields. The results include gradient.

Back to the list

numeric.foundation.variational.functional

Evaluates the integral of the Lagrangian along the sampled trajectory.

Signature
numeric.foundation.variational.functional(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • quadratic_lagrangian. Quadratic Lagrangian with mass and stiffness, consistent with the number of coordinates and velocities.

    Example with synthetic data. Enter, in order, vector(0,0.5,1) , vector(0,0.25,1). Choose the model quadratic_lagrangian . Set mass=1, stiffness=1 in the model fields. Press Preview fields. The results include action, density, velocity.

Back to the list

numeric.foundation.variational.legendre

Applies the Legendre transformation or calculation indicated by the variational model.

Signature
numeric.foundation.variational.legendre(functional, values, extra, options)
Arguments
functional values extra
Input shape
numeric arrays or execution-scoped callback
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1
Supported declarative models

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

  • quadratic_lagrangian. Quadratic Lagrangian with mass and stiffness, consistent with the number of coordinates and velocities.

    Example with synthetic data. Enter, in order, 0.5 , 1.5. Choose the model quadratic_lagrangian . Set mass=1, stiffness=1 in the model fields. Press Preview fields. The results include momentum, hamiltonian.

Back to the list

numeric.foundation.vector.angle

Angle between vectors.

Signature
numeric.foundation.vector.angle(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.contract

Contracts compatible indices and reduces the rank of the result according to the operation.

Signature
numeric.foundation.vector.contract(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.cross

Cross product of triples.

Signature
numeric.foundation.vector.cross(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.dot

Dot product.

Signature
numeric.foundation.vector.dot(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.norm

Norm of a vector.

Signature
numeric.foundation.vector.norm(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.normalize

Unit vector in the direction of the input.

Signature
numeric.foundation.vector.normalize(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.outer

Outer product.

Signature
numeric.foundation.vector.outer(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.projection

Vector projection.

Signature
numeric.foundation.vector.projection(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list

numeric.foundation.vector.triple

Triple product.

Signature
numeric.foundation.vector.triple(vector, other, third, options)
Arguments
vector other third
Input shape
numeric vectors
Unit rule
Units declared by whoever prepares the inputs.
Result shape
structured
Provider
math.numeric · NUMERIC_API_v1

Example with synthetic data. Enter, in order, vector(1,2,3), vector(2,5,1), vector(0,0,1). Press Preview fields. The results include value_real, value_imaginary.

Back to the list