/* * @license Apache-2.0 * * Copyright (c) 2019 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. */ // TypeScript Version: 4.1 /** * Returns the variance of a Student's t distribution. * * ## Notes * * - If provided `1 < v <= 2`, the function returns positive infinity. * - If provided `v <= 1`, the function returns `NaN`. * * @param v - degrees of freedom * @returns variance * * @example * var v = variance( 9.0 ); * // returns ~1.286 * * @example * var v = variance( 2.0 ); * // returns Infinity * * @example * var v = variance( 0.5 ); * // returns NaN * * @example * var v = variance( -0.2 ); * // returns NaN * * @example * var v = variance( NaN ); * // returns NaN */ declare function variance( v: number ): number; // EXPORTS // export = variance;