File size: 5,157 Bytes
597ee18 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | /**
* @license Apache-2.0
*
* Copyright (c) 2020 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 randu = require( '@stdlib/random/iter/randu' );
var factorialln = require( '@stdlib/math/base/special/factorialln' );
var linspace = require( '@stdlib/iter/linspace' );
var array2iterator = require( '@stdlib/array/to-iterator' );
var iterFactorialln = require( './../lib' );
// TESTS //
tape( 'main export is a function', function test( t ) {
t.ok( true, __filename );
t.equal( typeof iterFactorialln, 'function', 'main export is a function' );
t.end();
});
tape( 'the function throws an error if provided an iterator argument which is not an iterator protocol-compliant object', function test( t ) {
var values;
var i;
values = [
'5',
5,
NaN,
true,
false,
null,
void 0,
{},
[],
function noop() {}
];
for ( i = 0; i < values.length; i++ ) {
t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] );
}
t.end();
function badValue( value ) {
return function badValue() {
iterFactorialln( value );
};
}
});
tape( 'the function returns an iterator protocol-compliant object', function test( t ) {
var it;
var r;
var i;
it = iterFactorialln( randu() );
t.equal( it.next.length, 0, 'has zero arity' );
for ( i = 0; i < 100; i++ ) {
r = it.next();
t.equal( typeof r.value, 'number', 'returns a number' );
t.equal( typeof r.done, 'boolean', 'returns a boolean' );
}
t.end();
});
tape( 'the function returns an iterator protocol-compliant object which evaluates the natural logarithm of the factorial function for each iterated value', function test( t ) {
var expected;
var it;
var N;
var x;
var r;
var i;
N = 101;
it = iterFactorialln( linspace( 0.0, 10.0, N ) );
t.equal( it.next.length, 0, 'has zero arity' );
x = linspace( 0.0, 10.0, N );
for ( i = 0; i < N; i++ ) {
r = it.next();
expected = factorialln( x.next().value );
t.equal( r.value, expected, 'returns expected value' );
t.equal( typeof r.done, 'boolean', 'returns a boolean' );
}
r = it.next();
t.equal( r.value, void 0, 'returns expected value' );
t.equal( r.done, true, 'returns expected value' );
t.end();
});
tape( 'the function returns an iterator protocol-compliant object which returns `NaN` if provided a non-numeric value', function test( t ) {
var expected;
var values;
var actual;
var it;
var r;
var i;
values = [ 'abc', null, true, false, [], {} ];
expected = [
{
'value': NaN,
'done': false
},
{
'value': NaN,
'done': false
},
{
'value': NaN,
'done': false
},
{
'value': NaN,
'done': false
},
{
'value': NaN,
'done': false
},
{
'value': NaN,
'done': false
},
{
'done': true
}
];
it = iterFactorialln( array2iterator( values ) );
t.equal( it.next.length, 0, 'has zero arity' );
for ( i = 0; i < expected.length; i++ ) {
actual = it.next();
r = expected[ i ].value;
if ( r === r ) {
t.equal( actual.value, r, 'returns expected value' );
} else {
t.notEqual( actual.value, actual.value, 'returns expected value' );
}
t.equal( actual.done, expected[ i ].done, 'returns a boolean' );
}
t.end();
});
tape( 'the returned iterator has a `return` method for closing an iterator (no argument)', function test( t ) {
var it;
var r;
it = iterFactorialln( randu() );
r = it.next();
t.equal( typeof r.value, 'number', 'returns a number' );
t.equal( r.done, false, 'returns expected value' );
r = it.next();
t.equal( typeof r.value, 'number', 'returns a number' );
t.equal( r.done, false, 'returns expected value' );
r = it.return();
t.equal( r.value, void 0, 'returns expected value' );
t.equal( r.done, true, 'returns expected value' );
r = it.next();
t.equal( r.value, void 0, 'returns expected value' );
t.equal( r.done, true, 'returns expected value' );
t.end();
});
tape( 'the returned iterator has a `return` method for closing an iterator (argument)', function test( t ) {
var it;
var r;
it = iterFactorialln( randu() );
r = it.next();
t.equal( typeof r.value, 'number', 'returns a number' );
t.equal( r.done, false, 'returns expected value' );
r = it.next();
t.equal( typeof r.value, 'number', 'returns a number' );
t.equal( r.done, false, 'returns expected value' );
r = it.return( 'finished' );
t.equal( r.value, 'finished', 'returns expected value' );
t.equal( r.done, true, 'returns expected value' );
r = it.next();
t.equal( r.value, void 0, 'returns expected value' );
t.equal( r.done, true, 'returns expected value' );
t.end();
});
|