Skip to content

Commit 6cbdcae

Browse files
kgrytekgryte
committed
docs: update test messages, comments, and benchmarks
Ref: #1354 Ref: 609682c
1 parent 2db41a9 commit 6cbdcae

File tree

6 files changed

+134
-42
lines changed

6 files changed

+134
-42
lines changed

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/benchmark/benchmark.js

Lines changed: 109 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,39 @@ var isNonNegativeFinite = require( './../lib' );
3333

3434
// MAIN //
3535

36-
bench( pkg+'::primitives', function benchmark( b ) {
36+
bench( pkg+'::true,primitives', function benchmark( b ) {
3737
var values;
3838
var bool;
3939
var i;
4040

4141
values = [
42-
'5',
4342
5.0,
4443
4.0,
45-
3.14,
44+
3.14
45+
];
46+
47+
b.tic();
48+
for ( i = 0; i < b.iterations; i++ ) {
49+
bool = isNonNegativeFinite( values[ i % values.length ] );
50+
if ( typeof bool !== 'boolean' ) {
51+
b.fail( 'should return a boolean' );
52+
}
53+
}
54+
b.toc();
55+
if ( !isBoolean( bool ) ) {
56+
b.fail( 'should return a boolean' );
57+
}
58+
b.pass( 'benchmark finished' );
59+
b.end();
60+
});
61+
62+
bench( pkg+'::false,primitives', function benchmark( b ) {
63+
var values;
64+
var bool;
65+
var i;
66+
67+
values = [
68+
'5',
4669
-5.0,
4770
-4.0,
4871
NaN,
@@ -69,7 +92,32 @@ bench( pkg+'::primitives', function benchmark( b ) {
6992
b.end();
7093
});
7194

72-
bench( pkg+'::objects', function benchmark( b ) {
95+
bench( pkg+'::true,objects', function benchmark( b ) {
96+
var values;
97+
var bool;
98+
var i;
99+
100+
values = [
101+
new Number( 2.0 ),
102+
new Number( 3.14 )
103+
];
104+
105+
b.tic();
106+
for ( i = 0; i < b.iterations; i++ ) {
107+
bool = isNonNegativeFinite( values[ i % values.length ] );
108+
if ( typeof bool !== 'boolean' ) {
109+
b.fail( 'should return a boolean' );
110+
}
111+
}
112+
b.toc();
113+
if ( !isBoolean( bool ) ) {
114+
b.fail( 'should return a boolean' );
115+
}
116+
b.pass( 'benchmark finished' );
117+
b.end();
118+
});
119+
120+
bench( pkg+'::false,objects', function benchmark( b ) {
73121
var values;
74122
var bool;
75123
var i;
@@ -78,9 +126,7 @@ bench( pkg+'::objects', function benchmark( b ) {
78126
[],
79127
{},
80128
function noop() {},
81-
new Number( 2.0 ),
82-
new Number( -3.0 ),
83-
new Number( 3.14 )
129+
new Number( -3.0 )
84130
];
85131

86132
b.tic();
@@ -98,16 +144,39 @@ bench( pkg+'::objects', function benchmark( b ) {
98144
b.end();
99145
});
100146

101-
bench( pkg+'::primitives:isPrimitive', function benchmark( b ) {
147+
bench( pkg+'::true,primitives:isPrimitive', function benchmark( b ) {
102148
var values;
103149
var bool;
104150
var i;
105151

106152
values = [
107-
'5',
108153
5.0,
109154
4.0,
110-
3.14,
155+
3.14
156+
];
157+
158+
b.tic();
159+
for ( i = 0; i < b.iterations; i++ ) {
160+
bool = isNonNegativeFinite.isPrimitive( values[ i % values.length ] );
161+
if ( typeof bool !== 'boolean' ) {
162+
b.fail( 'should return a boolean' );
163+
}
164+
}
165+
b.toc();
166+
if ( !isBoolean( bool ) ) {
167+
b.fail( 'should return a boolean' );
168+
}
169+
b.pass( 'benchmark finished' );
170+
b.end();
171+
});
172+
173+
bench( pkg+'::false,primitives:isPrimitive', function benchmark( b ) {
174+
var values;
175+
var bool;
176+
var i;
177+
178+
values = [
179+
'5',
111180
-5.0,
112181
-4.0,
113182
NaN,
@@ -134,7 +203,7 @@ bench( pkg+'::primitives:isPrimitive', function benchmark( b ) {
134203
b.end();
135204
});
136205

137-
bench( pkg+'::objects:isPrimitive', function benchmark( b ) {
206+
bench( pkg+'::false,objects:isPrimitive', function benchmark( b ) {
138207
var values;
139208
var bool;
140209
var i;
@@ -144,8 +213,8 @@ bench( pkg+'::objects:isPrimitive', function benchmark( b ) {
144213
{},
145214
function noop() {},
146215
new Number( 2.0 ),
147-
new Number( -3.0 ),
148-
new Number( 3.14 )
216+
new Number( 3.14 ),
217+
new Number( -3.0 )
149218
];
150219

151220
b.tic();
@@ -163,7 +232,7 @@ bench( pkg+'::objects:isPrimitive', function benchmark( b ) {
163232
b.end();
164233
});
165234

166-
bench( pkg+'::primitives:isObject', function benchmark( b ) {
235+
bench( pkg+'::false,primitives:isObject', function benchmark( b ) {
167236
var values;
168237
var bool;
169238
var i;
@@ -199,7 +268,32 @@ bench( pkg+'::primitives:isObject', function benchmark( b ) {
199268
b.end();
200269
});
201270

202-
bench( pkg+'::objects:isObject', function benchmark( b ) {
271+
bench( pkg+'::true,objects:isObject', function benchmark( b ) {
272+
var values;
273+
var bool;
274+
var i;
275+
276+
values = [
277+
new Number( 2.0 ),
278+
new Number( 3.14 )
279+
];
280+
281+
b.tic();
282+
for ( i = 0; i < b.iterations; i++ ) {
283+
bool = isNonNegativeFinite.isObject( values[ i % values.length ] );
284+
if ( typeof bool !== 'boolean' ) {
285+
b.fail( 'should return a boolean' );
286+
}
287+
}
288+
b.toc();
289+
if ( !isBoolean( bool ) ) {
290+
b.fail( 'should return a boolean' );
291+
}
292+
b.pass( 'benchmark finished' );
293+
b.end();
294+
});
295+
296+
bench( pkg+'::false,objects:isObject', function benchmark( b ) {
203297
var values;
204298
var bool;
205299
var i;
@@ -208,9 +302,7 @@ bench( pkg+'::objects:isObject', function benchmark( b ) {
208302
[],
209303
{},
210304
function noop() {},
211-
new Number( 2.0 ),
212305
new Number( -3.0 ),
213-
new Number( 3.14 ),
214306
new Number( PINF )
215307
];
216308

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/repl.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
--------
1717
> var bool = {{alias}}( 5.0 )
1818
true
19-
> bool = {{alias}}( new Number( 5.0 ) )
19+
> bool = {{alias}}( new {{alias:@stdlib/number/ctor}}( 5.0 ) )
2020
true
2121
> bool = {{alias}}( 3.14 )
2222
true
@@ -46,7 +46,7 @@
4646
--------
4747
> var bool = {{alias}}.isPrimitive( 3.0 )
4848
true
49-
> bool = {{alias}}.isPrimitive( new Number( 3.0 ) )
49+
> bool = {{alias}}.isPrimitive( new {{alias:@stdlib/number/ctor}}( 3.0 ) )
5050
false
5151

5252

@@ -68,7 +68,7 @@
6868
--------
6969
> var bool = {{alias}}.isObject( 3.0 )
7070
false
71-
> bool = {{alias}}.isObject( new Number( 3.0 ) )
71+
> bool = {{alias}}.isObject( new {{alias:@stdlib/number/ctor}}( 3.0 ) )
7272
true
7373

7474

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,27 +33,27 @@ import isNonNegativeFinite = require( './index' );
3333
isNonNegativeFinite( 2, 123 ); // $ExpectError
3434
}
3535

36-
// Attached to main export is an isPrimitive method which returns a boolean...
36+
// Attached to main export is an `isPrimitive` method which returns a boolean...
3737
{
3838
// eslint-disable-next-line no-new-wrappers
3939
isNonNegativeFinite.isPrimitive( new Number( 2 ) ); // $ExpectType boolean
4040
isNonNegativeFinite.isPrimitive( 2 ); // $ExpectType boolean
4141
}
4242

43-
// The compiler throws an error if the isPrimitive method is provided an unsupported number of arguments...
43+
// The compiler throws an error if the `isPrimitive` method is provided an unsupported number of arguments...
4444
{
4545
isNonNegativeFinite.isPrimitive(); // $ExpectError
4646
isNonNegativeFinite.isPrimitive( 2, 123 ); // $ExpectError
4747
}
4848

49-
// Attached to main export is an isObject method which returns a boolean...
49+
// Attached to main export is an `isObject` method which returns a boolean...
5050
{
5151
// eslint-disable-next-line no-new-wrappers
5252
isNonNegativeFinite.isObject( new Number( 2 ) ); // $ExpectType boolean
5353
isNonNegativeFinite.isObject( 2 ); // $ExpectType boolean
5454
}
5555

56-
// The compiler throws an error if the isObject method is provided an unsupported number of arguments...
56+
// The compiler throws an error if the `isObject` method is provided an unsupported number of arguments...
5757
{
5858
isNonNegativeFinite.isObject(); // $ExpectError
5959
isNonNegativeFinite.isObject( 2, 123 ); // $ExpectError

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.main.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ tape( 'main export is a function', function test( t ) {
3333
t.end();
3434
});
3535

36-
tape( 'the function returns `true` if provided a number having a nonnegative number value', function test( t ) {
37-
t.equal( isNonNegativeFinite( 5.0 ), true, 'returns true' );
38-
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), true, 'returns true' );
36+
tape( 'the function returns `true` if provided a number having a nonnegative finite value', function test( t ) {
37+
t.equal( isNonNegativeFinite( 5.0 ), true, 'returns expected value' );
38+
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), true, 'returns expected value' );
3939
t.end();
4040
});
4141

@@ -58,7 +58,7 @@ tape( 'the function returns `false` if not provided a number having a nonnegativ
5858
];
5959

6060
for ( i = 0; i < values.length; i++ ) {
61-
t.equal( isNonNegativeFinite( values[i] ), false, 'returns false when provided '+values[i] );
61+
t.equal( isNonNegativeFinite( values[i] ), false, 'returns expected value when provided '+values[i] );
6262
}
6363
t.end();
6464
});

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.object.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,18 @@ tape( 'main export is a function', function test( t ) {
3333
t.end();
3434
});
3535

36-
tape( 'the function returns `true` if provided a number object having a nonnegative number value', function test( t ) {
37-
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), true, 'returns true' );
36+
tape( 'the function returns `true` if provided a number object having a nonnegative finite value', function test( t ) {
37+
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), true, 'returns expected value' );
3838
t.end();
3939
});
4040

41-
tape( 'the function returns `false` if provided positive infinity', function test( t ) {
42-
t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns false' );
41+
tape( 'the function returns `false` if provided positive infinity (primitive)', function test( t ) {
42+
t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns expected value' );
4343
t.end();
4444
});
4545

46-
tape( 'the function returns `false` if provided positive infinity', function test( t ) {
47-
t.equal( isNonNegativeFinite( new Number( 1.0/0.0 ) ), false, 'returns false' );
46+
tape( 'the function returns `false` if provided positive infinity (object)', function test( t ) {
47+
t.equal( isNonNegativeFinite( new Number( 1.0/0.0 ) ), false, 'returns expected value' );
4848
t.end();
4949
});
5050

@@ -68,7 +68,7 @@ tape( 'the function returns `false` if not provided a nonnegative number', funct
6868
];
6969

7070
for ( i = 0; i < values.length; i++ ) {
71-
t.equal( isNonNegativeFinite( values[i] ), false, 'returns false when provided '+values[i] );
71+
t.equal( isNonNegativeFinite( values[i] ), false, 'returns expected value when provided '+values[i] );
7272
}
7373
t.end();
7474
});

‎lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.primitive.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,22 @@ tape( 'main export is a function', function test( t ) {
3434
});
3535

3636
tape( 'the function returns `true` if provided a primitive number having a nonnegative finite value', function test( t ) {
37-
t.equal( isNonNegativeFinite( 3.0 ), true, 'returns true' );
37+
t.equal( isNonNegativeFinite( 3.0 ), true, 'returns expected value' );
3838
t.end();
3939
});
4040

4141
tape( 'the function returns `false` if provided a number object, even if the number has a nonnegative finite value', function test( t ) {
42-
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), false, 'returns false' );
42+
t.equal( isNonNegativeFinite( new Number( 5.0 ) ), false, 'returns expected value' );
4343
t.end();
4444
});
4545

46-
tape( 'the function returns `false` if provided positive infinity', function test( t ) {
47-
t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns false' );
46+
tape( 'the function returns `false` if provided positive infinity (primitive)', function test( t ) {
47+
t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns expected value' );
4848
t.end();
4949
});
5050

51-
tape( 'the function returns `false` if provided a number object with positive infinity', function test( t ) {
52-
t.equal( isNonNegativeFinite( new Number( 1.0/0.0 ) ), false, 'returns false' );
51+
tape( 'the function returns `false` if provided positive infinity (object)', function test( t ) {
52+
t.equal( isNonNegativeFinite( new Number( 1.0/0.0 ) ), false, 'returns expected value' );
5353
t.end();
5454
});
5555

@@ -70,7 +70,7 @@ tape( 'the function returns `false` if not provided a nonnegative finite number'
7070
];
7171

7272
for ( i = 0; i < values.length; i++ ) {
73-
t.equal( isNonNegativeFinite( values[i] ), false, 'returns false when provided '+values[i] );
73+
t.equal( isNonNegativeFinite( values[i] ), false, 'returns expected value when provided '+values[i] );
7474
}
7575
t.end();
7676
});

0 commit comments

Comments
 (0)