@stdlib/math-base-special-boxcox

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

boxcox

Compute a one-parameter Box-Cox transformation.

The one-parameter Box-Cox transformation is defined as

Installation

npm install @stdlib/math-base-special-boxcox

Usage

var boxcox = require( '@stdlib/math-base-special-boxcox' );

boxcox( x, lambda )

Computes a one-parameter Box-Cox transformation.

var v = boxcox( 1.0, 2.5 );
// returns 0.0

v = boxcox( 4.0, 2.5 );
// returns 12.4

v = boxcox( 10.0, 2.5 );
// returns ~126.0911

v = boxcox( 2.0, 0.0 );
// returns ~0.6931

v = boxcox( -1.0, 2.5 );
// returns NaN

v = boxcox( 0.0, -1.0 );
// returns -Infinity

Examples

var incrspace = require( '@stdlib/array-base-incrspace' );
var boxcox = require( '@stdlib/math-base-special-boxcox' );

var x = incrspace( -1.0, 10.0, 1.0 );
var l = incrspace( -0.5, 5.0, 0.5 );

var b;
var i;
var j;
for ( i = 0; i < x.length; i++ ) {
    for ( j = 0; j < l.length; j++ ) {
        b = boxcox( x[ i ], l[ j ] );
        console.log( 'boxcox(%d, %d) = %d', x[ i ], l[ j ], b );
    }
}

---

C APIs

Usage

#include "stdlib/math/base/special/boxcox.h"

stdlib_base_boxcox( x, lambda )

Computes a one-parameter Box-Cox transformation.

double out = stdlib_base_boxcox( 1.0, 2.5 );
// returns 0.0

out = stdlib_base_boxcox( 4.0, 2.5 );
// returns 12.4

The function accepts the following arguments:

• x: [in] double input value.
• lambda: [in] double power parameter.

double stdlib_base_boxcox ( const double x, const double lambda );

Examples

#include "stdlib/math/base/special/boxcox.h"
#include <stdio.h>

int main( void ) {
    const double x[] = { -1.0, 10.0, 1.0 };
    const double y[] = { -0.5, 5.0, 0.5 };

    double out;
    int i;
    int j;
    for ( i = 0; i < 3; i++ ) {
        for ( j = 0; j < 3; j++ ) {
            out = stdlib_base_boxcox( x[ i ], y[ j ] );
            printf ( "x: %lf, y: %lf, out: %lf\n", x[ i ], y[ j ], out );
        }
    }
}

References

• Box, G. E. P., and D. R. Cox. 1964. "An Analysis of Transformations." Journal of the Royal Statistical Society. Series B (Methodological) 26 (2). [Royal Statistical Society, Wiley]: 211–52. http://www.jstor.org/stable/2984418.

---

See Also

• @stdlib/math-base/special/boxcoxinv: compute the inverse of a one-parameter Box-Cox transformation.
• @stdlib/math-base/special/boxcox1p: compute a one-parameter Box-Cox transformation of 1+x.
• @stdlib/math-base/special/boxcox1pinv: compute the inverse of a one-parameter Box-Cox transformation for 1+x.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright 2016-2026. The Stdlib Authors.