Skip to content

Commit

Permalink
feat: add constants/float32/ln-pi
Browse files Browse the repository at this point in the history
PR-URL: #3342
Closes: #3344
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Signed-off-by: Athan Reines <[email protected]>
Co-authored-by: stdlib-bot <[email protected]>
  • Loading branch information
3 people authored Dec 13, 2024
1 parent f9466a9 commit fc8571d
Show file tree
Hide file tree
Showing 10 changed files with 466 additions and 0 deletions.
147 changes: 147 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/ln-pi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
<!--
@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_LN_PI

> Natural logarithm of the mathematical constant [π][pi] as a single-precision floating-point number.
<section class="usage">

## Usage

```javascript
var FLOAT32_LN_PI = require( '@stdlib/constants/float32/ln-pi' );
```

#### FLOAT32_LN_PI

Natural logarithm of the mathematical constant [π][pi] as a single-precision floating-point number.

```javascript
var bool = ( FLOAT32_LN_PI === 1.1447298526763916 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

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

```javascript
var FLOAT32_LN_PI = require( '@stdlib/constants/float32/ln-pi' );

console.log( FLOAT32_LN_PI );
// => 1.1447298526763916
```

</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/ln_pi.h"
```

#### STDLIB_CONSTANT_FLOAT32_LN_PI

Macro for the natural logarithm of the mathematical constant [π][pi] 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">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]</span><span class="delimiter">: </span><span class="description">π.</span>

</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">

[pi]: https://en.wikipedia.org/wiki/Pi

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

[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi

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

</section>

<!-- /.links -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/ln-pi/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{{alias}}
Natural logarithm of the mathematical constant `π` as a single-precision
floating-point number.

Examples
--------
> {{alias}}
1.1447298526763916

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

/**
* Natural logarithm of the mathematical constant `π` as a single-precision floating-point number.
*
* @example
* var val = FLOAT32_LN_PI;
* // returns 1.1447298526763916
*/
declare const FLOAT32_LN_PI: number;


// EXPORTS //

export = FLOAT32_LN_PI;
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_LN_PI = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT32_LN_PI; // $ExpectType number
}
24 changes: 24 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/ln-pi/examples/index.js
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_LN_PI = require( './../lib' );

console.log( FLOAT32_LN_PI );
// => 1.1447298526763916
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_LN_PI_H
#define STDLIB_CONSTANTS_FLOAT32_LN_PI_H

/**
* Macro for the natural logarithm of π as a single-precision floating-point number.
*/
#define STDLIB_CONSTANT_FLOAT32_LN_PI 1.1447298526763916f

#endif // !STDLIB_CONSTANTS_FLOAT32_LN_PI_H
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/ln-pi/lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* @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';

/**
* Natural logarithm of the mathematical constant `π` as a single-precision floating-point number.
*
* @module @stdlib/constants/float32/ln-pi
* @type {number}
*
* @example
* var FLOAT32_LN_PI = require( '@stdlib/constants/float32/ln-pi' );
* // returns 1.1447298526763916
*/


// MAIN //

/**
* Natural logarithm of the mathematical constant `π` as a single-precision floating-point number.
*
* @constant
* @type {number}
* @default 1.1447298526763916
* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Pi}
*/
var FLOAT32_LN_PI = 1.1447298526763916;


// EXPORTS //

module.exports = FLOAT32_LN_PI;
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/ln-pi/manifest.json
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

1 comment on commit fc8571d

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
constants/float32/ln-pi $\color{green}48/48$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}48/48$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.