<commit_before><!--

@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.

-->

# Fréchet Random Numbers

> Create an iterator for generating pseudorandom numbers drawn from a [Fréchet][frechet] distribution.

<section class="usage">

## Usage

```javascript
var iterator = require( '@stdlib/random/iterators/frechet' );
```

#### iterator( alpha, s, m\[, options] )

Returns an iterator for generating pseudorandom numbers drawn from a [Fréchet][frechet] distribution with parameters `alpha` (shape parameter) `s` (scale parameter), and `m` (location parameter).

```javascript
var it = iterator( 2.0, 5.0, 3.0 );
// returns <Object>

var r = it.next().value;
// returns <number>

r = it.next().value;
// returns <number>

r = it.next().value;
// returns <number>

// ...
```

If `alpha <= 0` or `s <= 0`, the function throws an error.

<!-- run throws: true -->

```javascript
var it = iterator( -1.0, 1.0, 0.0 );
// throws <TypeError><commit_msg>Fix missing comma<commit_after><!--

@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.

-->

# Fréchet Random Numbers

> Create an iterator for generating pseudorandom numbers drawn from a [Fréchet][frechet] distribution.

<section class="usage">

## Usage

```javascript
var iterator = require( '@stdlib/random/iterators/frechet' );
```

#### iterator( alpha, s, m\[, options] )

Returns an iterator for generating pseudorandom numbers drawn from a [Fréchet][frechet] distribution with parameters `alpha` (shape parameter), `s` (scale parameter), and `m` (location parameter).

```javascript
var it = iterator( 2.0, 5.0, 3.0 );
// returns <Object>

var r = it.next().value;
// returns <number>

r = it.next().value;
// returns <number>

r = it.next().value;
// returns <number>

// ...
```

If `alpha <= 0` or `s <= 0`, the function throws an error.

<!-- run throws: true -->

```javascript
var it = iterator( -1.0, 1.0, 0.0 );
// throws <TypeError>
{'fraction_non_alphanumeric': 0.1278246205733558, 'fraction_numerical': 0.016188870151770656, 'mean_word_length': 4.035653650254669, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 21, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2494170', 'n_tokens_mistral': 907, 'n_tokens_neox': 855, 'n_words': 369}