All files main.js

100% Statements 82/82
100% Branches 11/11
100% Functions 1/1
100% Lines 82/82

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 831x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2019x 2019x 2019x 2014x 2019x 7x 7x 2019x 1943x 1943x 69x 2019x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isnan = require( '@stdlib/math/base/assert/is-nan' );
 
 
// MAIN //
 
/**
* Computes the hinge loss gradient with respect to a model parameter.
*
* ## Notes
*
* -   If `y` is not +1 or -1, the function returns `NaN`.
* -   When `t=1.0`, we get the loss used by SVM, where as when `t=0.0`, we get the loss used by the Perceptron.
*
* @param {number} x - input value
* @param {number} t - margin threshold
* @param {number} y - true target value
* @param {number} p - predicted value
* @returns {number} hinge loss gradient
*
* @example
* var v = hingeGradient( 3.0, 1.0, 1.0, 0.782 );
* // returns -3.0
*
* @example
* var v = hingeGradient( 2.5, 1.0, 1.0, 0.202 );
* // returns -2.5
*
* @example
* var v = hingeGradient( -1.3, 1.0, 1.0, -0.999 );
* // returns 1.3
*
* @example
* var v = hingeGradient( -2.0, 1.0, -1.0, 0.234 );
* // returns -2.0
*
* @example
* var v = hingeGradient( -2.0, 1.0, -1.0, 0.2 );
* // returns -2.0
*
* @example
* var v = hingeGradient( -1.3, 1.0, 1.0, -0.9 );
* // returns 1.3
*/
function hingeGradient( x, t, y, p ) {
	if (
		isnan( x ) || isnan( t ) || isnan( y ) || isnan( p ) ||
		( y !== -1.0 && y !== 1.0 )
	) {
		return NaN;
	}
	if ( y*p <= t ) {
		return -x*y;
	}
	return 0.0;
}
 
 
// EXPORTS //
 
module.exports = hingeGradient;