time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

mean.js (1092B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 // MAIN //
     22 
     23 /**
     24 * Returns the expected value of a degenerate distribution.
     25 *
     26 * @param {number} mu - constant value of distribution
     27 * @returns {number} expected value
     28 *
     29 * @example
     30 * var v = mean( 0.1 );
     31 * // returns 0.1
     32 *
     33 * @example
     34 * var v = mean( 0.5 );
     35 * // returns 0.5
     36 *
     37 * @example
     38 * var v = mean( 10.0 );
     39 * // returns 10.0
     40 *
     41 * @example
     42 * var v = mean( NaN );
     43 * // returns NaN
     44 */
     45 function mean( mu ) {
     46 	return mu;
     47 }
     48 
     49 
     50 // EXPORTS //
     51 
     52 module.exports = mean;