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!

logit

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [logit][logit] function.

The [logit][logit] function is defined as the logarithm of the odds p / (1-p); i.e.,

$Logit function.$

The [logit][logit] function is the inverse of the [standard logistic][standard-logistic] function, sometimes also called the sigmoid function.

Installation

``bash npm install @stdlib/math-base-special-logit`

`Usage`

`javascript var logit = require( '@stdlib/math-base-special-logit' );`

#### logit( p )

Computes the [logit][logit] function.

`javascript var v = logit( 0.2 ); // returns ~-1.386

v = logit( 0.9 ); // returns ~2.197`

If p < 0 or p > 1, the function returns NaN.

`javascript var v = logit( 1.3 ); // returns NaN

v = logit( -0.2 ); // returns NaN`

`Examples`

`javascript var uniform = require( '@stdlib/random-array-uniform' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var logit = require( '@stdlib/math-base-special-logit' );

var opts = { 'dtype': 'float64' }; var p = uniform( 100, 0.0, 1.0, opts );

logEachMap( 'logit(%0.4f) = %0.4f', p, logit );`

*

`C APIs`

`$3`

`c #include "stdlib/math/base/special/logit.h"`

#### stdlib_base_logit( p )

Computes the [logit][logit] function.

`c double out = stdlib_base_logit( 0.2 ); // returns ~-1.386

out = stdlib_base_logit( 0.9 ); // returns ~2.197`

The function accepts the following arguments:

- p: [in] double input value.

`c double stdlib_base_logit( const double p );`

`$3`

`c #include "stdlib/math/base/special/logit.h" #include #include

int main( void ) { double x; double v; int i;

for ( i = 0; i < 100; i++ ) { x = (double)rand() / (double)RAND_MAX; v = stdlib_base_logit( x ); printf( "logit(%lf) = %lf\n", x, v ); } }`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-logit.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-logit

[test-image]: https://github.com/stdlib-js/math-base-special-logit/actions/workflows/test.yml/badge.svg?branch=v0.2.4 [test-url]: https://github.com/stdlib-js/math-base-special-logit/actions/workflows/test.yml?query=branch:v0.2.4

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-logit/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-logit?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/math-base-special-logit/tree/deno [deno-readme]: https://github.com/stdlib-js/math-base-special-logit/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-logit/tree/umd [umd-readme]: https://github.com/stdlib-js/math-base-special-logit/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-base-special-logit/tree/esm [esm-readme]: https://github.com/stdlib-js/math-base-special-logit/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-base-special-logit/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-logit/main/LICENSE

[logit]: https://en.wikipedia.org/wiki/Logit

[standard-logistic]: https://en.wikipedia.org/wiki/Logistic_function


  
    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!

`logit`

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [logit][logit] function.

The [logit][logit] function is defined as the logarithm of the odds p / (1-p); i.e.,

The [logit][logit] function is the inverse of the [standard logistic][standard-logistic] function, sometimes also called the sigmoid function.

`Installation`

``bash npm install @stdlib/math-base-special-logit `

`Usage`

`javascript var logit = require( '@stdlib/math-base-special-logit' ); `

#### logit( p )

Computes the [logit][logit] function.

`javascript var v = logit( 0.2 ); // returns ~-1.386

v = logit( 0.9 ); // returns ~2.197 `

If p < 0 or p > 1, the function returns NaN.

`javascript var v = logit( 1.3 ); // returns NaN

v = logit( -0.2 ); // returns NaN `

`Examples`

`javascript var uniform = require( '@stdlib/random-array-uniform' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var logit = require( '@stdlib/math-base-special-logit' );

var opts = { 'dtype': 'float64' }; var p = uniform( 100, 0.0, 1.0, opts );

logEachMap( 'logit(%0.4f) = %0.4f', p, logit ); `

*

`C APIs`

`$3`

`c #include "stdlib/math/base/special/logit.h" `

#### stdlib_base_logit( p )

Computes the [logit][logit] function.

`c double out = stdlib_base_logit( 0.2 ); // returns ~-1.386

out = stdlib_base_logit( 0.9 ); // returns ~2.197 `

The function accepts the following arguments:

- p: [in] double input value.

`c double stdlib_base_logit( const double p ); `

`$3`

`c #include "stdlib/math/base/special/logit.h" #include #include

int main( void ) { double x; double v; int i;

for ( i = 0; i < 100; i++ ) { x = (double)rand() / (double)RAND_MAX; v = stdlib_base_logit( x ); printf( "logit(%lf) = %lf\n", x, v ); } } `

*

`Notice`

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

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-logit.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-logit

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-logit/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-logit?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-logit/main/LICENSE

[logit]: https://en.wikipedia.org/wiki/Logit

[standard-logistic]: https://en.wikipedia.org/wiki/Logistic_function