.. _auto_math_interpolate:

*INTERPOLATES TO RETURN A SET OF VALUES BETWEEN MIN AND MAX*
============================================================

Given a scalar X-Value and a range defined by Min, Max, and Increment, this worker interpolates to locate the X-Value within the generated sequence and returns either its interpolated time (position) or state (normalized value). Use it when you need to map an arbitrary scalar onto a evenly-spaced grid and retrieve the corresponding index or normalized state.

When to use
-----------

Classification: **process**.

Tagged: ``interpolate``, ``linear``, ``math``, ``process``, ``range``, ``scalar``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - X-Value
     - x-value
     - scalar
     - 1
     - ✓
     - The scalar value to interpolate within the [Min, Max] range; defaults to 1.
   * - Min
     - min
     - scalar
     - 0
     - ✓
     - The lower bound of the interpolation range (inclusive); defaults to 0.
   * - Max
     - max
     - scalar
     - 1
     - ✓
     - The upper bound of the interpolation range (inclusive); defaults to 1.
   * - Increment
     - increment
     - scalar
     - 0.1
     - ✓
     - Step size used to build the evenly-spaced sequence between Min and Max; defaults to 0.1.
   * - Return
     - return
     - string
     - time
     - ✓
     - Selects what the worker returns: 'time' for the interpolated position/index along the sequence, or 'state' for the normalized state value; defaults to 'time'.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - math_interpolate_output_1
     - math_interpolate_output_1
     - scalar
     - Interpolated scalar result — either the position (time) or the normalized state (state) of X-Value within the Min–Max sequence, depending on the Return selection.

Disciplines
-----------

- data.curve.transform
- data.statistics

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=math_interpolate <https://www.d3view.com/api/workflow/example?id=math_interpolate>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>math_interpolate</code>. Schema hash: <code>3074314de152</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>