time-to-botec

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

README.md (2388B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # Truncated Normal
     22 
     23 > Truncated normal distribution.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var truncatedNormal = require( '@stdlib/stats/base/dists/truncated-normal' );
     31 ```
     32 
     33 #### truncatedNormal
     34 
     35 Truncated normal distribution.
     36 
     37 ```javascript
     38 var dist = truncatedNormal;
     39 // returns {...}
     40 ```
     41 
     42 The namespace contains the following distribution functions:
     43 
     44 <!-- <toc pattern="*+(cdf|pdf|mgf|quantile)*"> -->
     45 
     46 <div class="namespace-toc">
     47 
     48 -   <span class="signature">[`pdf( x, a, b, mu, sigma )`][@stdlib/stats/base/dists/truncated-normal/pdf]</span><span class="delimiter">: </span><span class="description">truncated normal distribution probability density function (PDF).</span>
     49 
     50 </div>
     51 
     52 <!-- </toc> -->
     53 
     54 The namespace contains the following functions for calculating distribution properties:
     55 
     56 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> -->
     57 
     58 
     59 
     60 <!-- </toc> -->
     61 
     62 The namespace contains a constructor function for creating a [truncated normal][truncated-normal-distribution] distribution object.
     63 
     64 <!-- <toc pattern="*ctor*"> -->
     65 
     66 
     67 
     68 <!-- </toc> -->
     69 
     70 </section>
     71 
     72 <!-- /.usage -->
     73 
     74 <section class="examples">
     75 
     76 ## Examples
     77 
     78 <!-- TODO: better examples -->
     79 
     80 <!-- eslint no-undef: "error" -->
     81 
     82 ```javascript
     83 var objectKeys = require( '@stdlib/utils/keys' );
     84 var truncatedNormal = require( '@stdlib/stats/base/dists/truncated-normal' );
     85 
     86 console.log( objectKeys( truncatedNormal ) );
     87 ```
     88 
     89 </section>
     90 
     91 <!-- /.examples -->
     92 
     93 <section class="links">
     94 
     95 [truncated-normal-distribution]: https://en.wikipedia.org/wiki/Truncated_normal_distribution
     96 
     97 <!-- <toc-links> -->
     98 
     99 [@stdlib/stats/base/dists/truncated-normal/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/truncated-normal/pdf
    100 
    101 <!-- </toc-links> -->
    102 
    103 </section>
    104 
    105 <!-- /.links -->