Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/catalan/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<!--

@license Apache-2.0

Copyright (c) 2025 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.

-->

# FLOAT16_CATALAN

> [Catalan's constant][catalan-constant].

<section class="usage">

## Usage

```javascript
var FLOAT16_CATALAN = require( '@stdlib/constants/float16/catalan' );
```

#### FLOAT16_CATALAN

[Catalan's constant][catalan-constant].

```javascript
var bool = ( FLOAT16_CATALAN === 0.916015625 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

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

```javascript
var FLOAT16_CATALAN = require( '@stdlib/constants/float16/catalan' );

console.log( FLOAT16_CATALAN );
// => 0.916015625
```

</section>

<!-- /.examples -->

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

[catalan-constant]: https://en.wikipedia.org/wiki/Catalan%27s_constant

</section>

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

{{alias}}
Catalan's constant.

Examples
--------
> {{alias}}
0.916015625

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 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

/**
* Catalan's constant.
*
* @example
* var catalan = FLOAT16_CATALAN;
* // returns 0.916015625
*/
declare const FLOAT16_CATALAN: number;


// EXPORTS //

export = FLOAT16_CATALAN;
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 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 FLOAT16_CATALAN = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_CATALAN; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 FLOAT16_CATALAN = require( './../lib' );

console.log( FLOAT16_CATALAN );
// => 0.916015625
Comment on lines +23 to +24
Copy link
Member Author

Choose a reason for hiding this comment

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

The return value is calculated by:-

var float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' );

console.log( float64ToFloat16( 0.915965594177219 ) );

Output log:-

[Running] node "c:\Users\HP\Stdlib\stdlib\lib\node_modules\@stdlib\number\float64\base\to-float16\lib\i.js"
0.916015625

Copy link
Member Author

Choose a reason for hiding this comment

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

here 0.915965594177219 is the float64/catalan value.

49 changes: 49 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/catalan/lib/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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';

/**
* Catalan's constant.
*
* @module @stdlib/constants/float16/catalan
* @type {number}
*
* @example
* var FLOAT16_CATALAN = require( '@stdlib/constants/float16/catalan' );
* // returns 0.916015625
*/


// MAIN //

/**
* Catalan's constant.
*
* @constant
* @type {number}
* @default 0.916015625
* @see [OEIS]{@link http://oeis.org/A006752}
* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Catalan%27s_constant}
*/
var FLOAT16_CATALAN = 0.916015625;


// EXPORTS //

module.exports = FLOAT16_CATALAN;
70 changes: 70 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/catalan/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"name": "@stdlib/constants/float16/catalan",
"version": "0.0.0",
"description": "Catalan's constant.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
},
"contributors": [
{
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
}
],
"main": "./lib",
"directories": {
"doc": "./docs",
"example": "./examples",
"lib": "./lib",
"test": "./test"
},
"types": "./docs/types",
"scripts": {},
"homepage": "https://github.com/stdlib-js/stdlib",
"repository": {
"type": "git",
"url": "git://github.com/stdlib-js/stdlib.git"
},
"bugs": {
"url": "https://github.com/stdlib-js/stdlib/issues"
},
"dependencies": {},
"devDependencies": {},
"engines": {
"node": ">=0.10.0",
"npm": ">2.7.0"
},
"os": [
"aix",
"darwin",
"freebsd",
"linux",
"macos",
"openbsd",
"sunos",
"win32",
"windows"
],
"keywords": [
"stdlib",
"stdmath",
"constant",
"const",
"mathematics",
"math",
"catalan",
"combinatorics",
"polygamma",
"trigamma",
"c",
"k",
"g",
"ieee754",
"precision",
"floating-point",
"float",
"float16"
]
}
38 changes: 38 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/catalan/test/test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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';

// MODULES //

var tape = require( 'tape' );
var FLOAT16_CATALAN = require( './../lib' );


// TESTS //

tape( 'main export is a number', function test( t ) {
t.ok( true, __filename );
t.strictEqual( typeof FLOAT16_CATALAN, 'number', 'main export is a number' );
t.end();
});

tape( 'the exported value is a half-precision floating-point number equal to 0.916015625', function test( t ) {
t.strictEqual( FLOAT16_CATALAN, 0.916015625, 'returns expected value' );
t.end();
});