@stdlib/stats/iter/variance/docs/types/index.d.ts

Standard library statistical functions.

/*
* @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

/// <reference types="@stdlib/types"/>

import { Iterator } from '@stdlib/types/iter';

/**
* Computes the unbiased sample variance over all iterated values.
*
* @param iterator - input iterator
* @param mean - known mean
* @returns unbiased sample variance
*
* @example
* var runif = require( '@stdlib/random/iter/uniform' );
*
* var rand = runif( -10.0, 10.0, {
*     'iter': 100
* });
*
* var s2 = itervariance( rand );
* // returns <number>
*/
declare function itervariance( iterator: Iterator, mean?: number ): number | null;


// EXPORTS //

export = itervariance;