test.js

/**
* @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 lnf = require( '@stdlib/math/base/special/lnf' );
var absf = require( '@stdlib/math/base/special/absf' );
var EPS = require( '@stdlib/constants/float16/eps' );
var float64ToFloat16 = require( '@stdlib/number/float64/base/to-float16' );
var FLOAT16_LN2 = require( './../lib' );


// TESTS //

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

tape( 'export is a half-precision floating-point number equal to `0.693359375`', function test( t ) {
	t.strictEqual( FLOAT16_LN2, float64ToFloat16( 0.6931471805599453 ), 'returns expected value' );
	t.end();
});

tape( 'export equals `lnf(2)`', function test( t ) {
	var delta;
	var tol;
	var v;

	v = lnf( 2.0 );
	delta = absf( float64ToFloat16( v - FLOAT16_LN2 ) );
	tol = EPS * FLOAT16_LN2;

	t.ok( delta <= tol, 'equals lnf(2) within tolerance '+tol );

	t.end();
});