Skip to content

Commit

Permalink
feat: add constants/float32/half-ln-two
Browse files Browse the repository at this point in the history
  • Loading branch information
gunjjoshi committed Oct 15, 2024
1 parent 3282bd0 commit 966b427
Show file tree
Hide file tree
Showing 10 changed files with 477 additions and 0 deletions.
139 changes: 139 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/half-ln-two/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!--
@license Apache-2.0
Copyright (c) 2024 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

# FLOAT32_HALF_LN2

> One half times the [natural logarithm][@stdlib/math/base/special/ln] of `2` as a single-precision floating-point number.
<section class="usage">

## Usage

```javascript
var FLOAT32_HALF_LN2 = require( '@stdlib/constants/float32/half-ln-two' );
```

#### FLOAT32_HALF_LN2

One half times the [natural logarithm][@stdlib/math/base/special/ln] of `2` as a single-precision floating-point number.

```javascript
var bool = ( FLOAT32_HALF_LN2 === 0.3465735912322998 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

<!-- eslint no-undef: "error" -->

```javascript
var FLOAT32_HALF_LN2 = require( '@stdlib/constants/float32/half-ln-two' );

console.log( FLOAT32_HALF_LN2 );
// => 0.3465735912322998
```

</section>

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/constants/float32/half_ln_two.h"
```

#### STDLIB_CONSTANT_FLOAT32_HALF_LN2

Macro for one half times the [natural logarithm][@stdlib/math/base/special/ln] of `2` as a single-precision floating-point number.

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[@stdlib/math/base/special/ln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ln

<!-- <related-links> -->

<!-- </related-links> -->

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{{alias}}
One half times the natural logarithm of 2 as a single-precision
floating-point number.

Examples
--------
> {{alias}}
0.3465735912322998

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/**
* One half times the natural logarithm of 2 as a single-precision floating-point number.
*
* @example
* var val = FLOAT32_HALF_LN2;
* // returns 0.3465735912322998
*/
declare const FLOAT32_HALF_LN2: number;


// EXPORTS //

export = FLOAT32_HALF_LN2;
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import FLOAT32_HALF_LN2 = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT32_HALF_LN2; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

var FLOAT32_HALF_LN2 = require( './../lib' );

console.log( FLOAT32_HALF_LN2 );
// => 0.3465735912322998
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#ifndef STDLIB_CONSTANTS_FLOAT32_HALF_LN_TWO_H
#define STDLIB_CONSTANTS_FLOAT32_HALF_LN_TWO_H

/**
* Macro for one half times the natural logarithm of 2 as a single-precision floating-point number.
*/
#define STDLIB_CONSTANT_FLOAT32_HALF_LN_TWO 0.3465735912322998

#endif // !STDLIB_CONSTANTS_FLOAT32_HALF_LN_TWO_H
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2024 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

/**
* One half times the natural logarithm of 2 as a single-precision floating-point number.
*
* @module @stdlib/constants/float32/half-ln-two
* @type {number}
*
* @example
* var FLOAT32_HALF_LN2 = require( '@stdlib/constants/float32/half-ln-two' );
* // returns 0.3465735912322998
*/

// MAIN //

/**
* One half times the natural logarithm of 2 as a single-precision floating-point number.
*
* ```tex
* \frac{\ln 2}{2}
* ```
*
* @constant
* @type {number}
* @default 0.3465735912322998
*/
var FLOAT32_HALF_LN2 = 0.3465735912322998; // 0x3EB17218


// EXPORTS //

module.exports = FLOAT32_HALF_LN2;
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"options": {},
"fields": [
{
"field": "src",
"resolve": true,
"relative": true
},
{
"field": "include",
"resolve": true,
"relative": true
},
{
"field": "libraries",
"resolve": false,
"relative": false
},
{
"field": "libpath",
"resolve": true,
"relative": false
}
],
"confs": [
{
"src": [],
"include": [
"./include"
],
"libraries": [],
"libpath": [],
"dependencies": []
}
]
}
Loading

0 comments on commit 966b427

Please sign in to comment.