stdlib/lib/node_modules/@stdlib/math/base/tools/evalpoly-compile-c/docs/repl.txt at 56df58a7fb240b6d1e809d28f0149f52e31cb371 · stdlib-js/stdlib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{{alias}}( c[, options] )
    Compiles a C function string for evaluating a polynomial having
    coefficients `c`.

    The coefficients should be ordered in ascending degree, thus matching
    summation notation.

    By default, the function assumes double-precision floating-point arithmetic.
    To emulate single-precision floating-point arithmetic, set the `dtype`
    option to `'float'`.

    The function is intended for non-browser environments for the purpose of
    generating C source files.

    Parameters
    ----------
    c: Array<number>
        Polynomial coefficients sorted in ascending degree.

    options: Object (optional)
        Function options.

    options.dtype: string (optional)
        Input value floating-point data type. Must be either 'double' or
        'float'. Default: 'double'.

    options.name: string (optional)
        Function name. Default: 'evalpoly'.

    Returns
    -------
    out: string
        Function string for evaluating a polynomial.

    Examples
    --------
    > var str = {{alias}}( [ 3.0, 2.0, 1.0 ] )
    <string>


    See Also
    --------