All files / lib regularize.js

100% Statements 52/52
100% Branches 3/3
100% Functions 1/1
100% Lines 52/52

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 535x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 12x 12x 12x 5x 5x 5x 12x 5x 5x 5x 5x 5x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 max = require( '@stdlib/math/base/special/max' );
 
 
// VARIABLES //
 
var MIN_SCALING_FACTOR = 1e-7;
 
 
// MAIN //
 
/**
* L2 regularization of feature weights.
*
* @private
* @param {WeightVector} weights - current model coefficients
* @param {NonNegativeNumber} lambda - regularization parameter
* @param {PositiveNumber} eta - current learning rate
*/
function regularize( weights, lambda, eta ) {
	var scalingFactor;
	if ( lambda > 0.0 ) {
		scalingFactor = 1.0 - ( eta * lambda );
		weights.scaleTo( max( scalingFactor, MIN_SCALING_FACTOR ) );
	}
}
 
 
// EXPORTS //
 
module.exports = regularize;