Skip to content

Commit 909a027

Browse files
committed
docs: add edge case tests to repl.txt for sin()
2 parents ef73843 + 52ae09a commit 909a027

File tree

266 files changed

+3860
-1983
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+3860
-1983
lines changed

CONTRIBUTORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Justyn Shelby <[email protected]>
7878
Karan Anand <[email protected]>
7979
Karthik Prakash <[email protected]>
8080
Kaushikgtm <[email protected]>
81+
Kavyansh-Bagdi <[email protected]>
8182
Kohantika Nath <[email protected]>
8283
Krishnam Agarwal <[email protected]>
8384
Krishnendu Das <[email protected]>

docs/contributing/FAQ.md

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ limitations under the License.
2727
- [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
2828
- [How can I install cppcheck?](#install-cppcheck)
2929
- [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
30-
- [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
30+
- [What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length)
31+
- [What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?](#max-params)
3132
- [I have opened a pull request, where can I seek feedback?](#pr-feedback)
3233
- [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
3334
- [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
@@ -64,8 +65,6 @@ There are primarily two options for setting up your development environment to c
6465

6566
Note: The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this [issue][devcontainer-issue].
6667

67-
TODO: Modify the dev container setup link to the exact file link once it is merged.
68-
6968
<a name="install-cppcheck"></a>
7069

7170
## How can I install cppcheck?
@@ -101,15 +100,37 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that
101100

102101
<a name="markdown-heading-length"></a>
103102

104-
## What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?
103+
## What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?
104+
105+
Consider whether the heading/line can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
106+
107+
- For JavaScript files:
105108

106-
Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
109+
```javascript
110+
// eslint-disable-line max-len
111+
```
112+
113+
[Reference Comment][javascript-len-ref]
114+
115+
- For Markdown files:
107116

108117
```markdown
109118
<!-- lint disable maximum-heading-length -->
110119
```
111120

112-
TODO: Can we add a reference PR link?
121+
[Reference Comment][markdown-len-ref]
122+
123+
<a name="markdown-heading-length"></a>
124+
125+
## What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?
126+
127+
Consider whether the number of parameters can be reduced. If reduction is not possible, disable the lint rule at the top level using:
128+
129+
```javascript
130+
// eslint-disable-line max-params
131+
```
132+
133+
[Reference Comment][javascript-params-ref]
113134

114135
<a name="pr-feedback"></a>
115136

@@ -386,6 +407,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
386407

387408
[make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib
388409

410+
[markdown-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/README.md?plain=1#L94
411+
412+
[javascript-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L111
413+
414+
[javascript-params-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L75
415+
389416
</section>
390417

391418
<!-- /.links -->

lib/node_modules/@stdlib/console/docs/types/index.d.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,20 @@ interface Namespace {
5959
*
6060
* ns.logEach( '%d < %d ', x, y );
6161
* // e.g., => '1 < 4\n2 < 5\n3 < 6\n'
62+
*
63+
* @example
64+
* var x = [ 0.5, 1.0, 1.5 ];
65+
* var y = [ 0.25, 0.5, 0.75 ];
66+
*
67+
* ns.logEach( '%0.2f > %0.2f', x, y );
68+
* // e.g., => '0.50 > 0.25\n1.00 > 0.50\n1.50 > 0.75\n'
69+
*
70+
* @example
71+
* var x = [ 'foo', 'bar' ];
72+
* var y = [ 'beep', 'boop' ];
73+
*
74+
* ns.logEach( 'x: %s, y: %s', x, y );
75+
* // e.g., => 'x: foo, y: beep\nx: bar, y: boop\n'
6276
*/
6377
logEach: typeof logEach;
6478

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# FLOAT32_NUM_SIGNIFICAND_BITS
22+
23+
> Number of significand bits for a [single-precision floating-point number][ieee754].
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
<!-- eslint-disable id-length -->
30+
31+
```javascript
32+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( '@stdlib/constants/float32/num-significand-bits' );
33+
```
34+
35+
#### FLOAT32_NUM_SIGNIFICAND_BITS
36+
37+
Number of significand bits for a [single-precision floating-point number][ieee754].
38+
39+
<!-- eslint-disable id-length -->
40+
41+
```javascript
42+
var bool = ( FLOAT32_NUM_SIGNIFICAND_BITS === 23 );
43+
// returns true
44+
```
45+
46+
</section>
47+
48+
<!-- /.usage -->
49+
50+
<section class="examples">
51+
52+
## Examples
53+
54+
<!-- eslint-disable id-length -->
55+
56+
<!-- eslint no-undef: "error" -->
57+
58+
```javascript
59+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( '@stdlib/constants/float32/num-significand-bits' );
60+
61+
console.log( FLOAT32_NUM_SIGNIFICAND_BITS );
62+
// => 23
63+
```
64+
65+
</section>
66+
67+
<!-- /.examples -->
68+
69+
<!-- C interface documentation. -->
70+
71+
* * *
72+
73+
<section class="c">
74+
75+
## C APIs
76+
77+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
78+
79+
<section class="intro">
80+
81+
</section>
82+
83+
<!-- /.intro -->
84+
85+
<!-- C usage documentation. -->
86+
87+
<section class="usage">
88+
89+
### Usage
90+
91+
```c
92+
#include "stdlib/constants/float32/num_significand_bits.h"
93+
```
94+
95+
#### STDLIB_CONSTANT_FLOAT32_NUM_SIGNIFICAND_BITS
96+
97+
Number of significand bits for a [single-precision floating-point number][ieee754].
98+
99+
</section>
100+
101+
<!-- /.usage -->
102+
103+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
104+
105+
<section class="notes">
106+
107+
</section>
108+
109+
<!-- /.notes -->
110+
111+
<!-- C API usage examples. -->
112+
113+
<section class="examples">
114+
115+
</section>
116+
117+
<!-- /.examples -->
118+
119+
</section>
120+
121+
<!-- /.c -->
122+
123+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
124+
125+
<section class="related">
126+
127+
</section>
128+
129+
<!-- /.related -->
130+
131+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
132+
133+
<section class="links">
134+
135+
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
136+
137+
<!-- <related-links> -->
138+
139+
<!-- </related-links> -->
140+
141+
</section>
142+
143+
<!-- /.links -->
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
{{alias}}
3+
Number of significand bits for a single-precision floating-
4+
point number.
5+
6+
Examples
7+
--------
8+
> {{alias}}
9+
23
10+
11+
See Also
12+
--------
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Number of significand bits for a single-precision floating-point number.
23+
*
24+
* @example
25+
* var bits = FLOAT32_NUM_SIGNIFICAND_BITS;
26+
* // returns 23
27+
*/
28+
declare const FLOAT32_NUM_SIGNIFICAND_BITS: number;
29+
30+
31+
// EXPORTS //
32+
33+
export = FLOAT32_NUM_SIGNIFICAND_BITS;
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import FLOAT32_NUM_SIGNIFICAND_BITS = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The export is a number...
25+
{
26+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
27+
FLOAT32_NUM_SIGNIFICAND_BITS; // $ExpectType number
28+
}
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( './../lib' );
22+
23+
console.log( FLOAT32_NUM_SIGNIFICAND_BITS );
24+
// => 23
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#ifndef STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H
20+
#define STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H
21+
22+
/**
23+
* Number of significand bits for a single-precision floating-point number.
24+
*/
25+
#define STDLIB_CONSTANT_FLOAT32_NUM_SIGNIFICAND_BITS 23
26+
27+
#endif // !STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H

0 commit comments

Comments
 (0)