README.md (6805B)
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 # Cosine 22 23 > Raised cosine distribution. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var cosine = require( '@stdlib/stats/base/dists/cosine' ); 31 ``` 32 33 #### cosine 34 35 Raised cosine distribution. 36 37 ```javascript 38 var dist = cosine; 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">[`cdf( x, mu, s )`][@stdlib/stats/base/dists/cosine/cdf]</span><span class="delimiter">: </span><span class="description">raised cosine distribution cumulative distribution function.</span> 49 - <span class="signature">[`logcdf( x, mu, s )`][@stdlib/stats/base/dists/cosine/logcdf]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of the cumulative distribution function (CDF) for a raised cosine distribution.</span> 50 - <span class="signature">[`logpdf( x, mu, s )`][@stdlib/stats/base/dists/cosine/logpdf]</span><span class="delimiter">: </span><span class="description">raised cosine distribution logarithm of probability density function (PDF).</span> 51 - <span class="signature">[`mgf( t, mu, s )`][@stdlib/stats/base/dists/cosine/mgf]</span><span class="delimiter">: </span><span class="description">raised cosine distribution moment-generating function.</span> 52 - <span class="signature">[`pdf( x, mu, s )`][@stdlib/stats/base/dists/cosine/pdf]</span><span class="delimiter">: </span><span class="description">raised cosine distribution probability density function (PDF).</span> 53 - <span class="signature">[`quantile( p, mu, s )`][@stdlib/stats/base/dists/cosine/quantile]</span><span class="delimiter">: </span><span class="description">raised cosine distribution quantile function.</span> 54 55 </div> 56 57 <!-- </toc> --> 58 59 The namespace contains the following functions for calculating distribution properties: 60 61 <!-- <toc pattern="*+(entropy|kurtosis|mean|median|mode|skewness|stdev|variance)*"> --> 62 63 <div class="namespace-toc"> 64 65 - <span class="signature">[`kurtosis( mu, s )`][@stdlib/stats/base/dists/cosine/kurtosis]</span><span class="delimiter">: </span><span class="description">raised cosine distribution excess kurtosis.</span> 66 - <span class="signature">[`mean( mu, s )`][@stdlib/stats/base/dists/cosine/mean]</span><span class="delimiter">: </span><span class="description">raised cosine distribution expected value.</span> 67 - <span class="signature">[`median( mu, s )`][@stdlib/stats/base/dists/cosine/median]</span><span class="delimiter">: </span><span class="description">raised cosine distribution median.</span> 68 - <span class="signature">[`mode( mu, s )`][@stdlib/stats/base/dists/cosine/mode]</span><span class="delimiter">: </span><span class="description">raised cosine distribution mode.</span> 69 - <span class="signature">[`skewness( mu, s )`][@stdlib/stats/base/dists/cosine/skewness]</span><span class="delimiter">: </span><span class="description">raised cosine distribution skewness.</span> 70 - <span class="signature">[`stdev( mu, s )`][@stdlib/stats/base/dists/cosine/stdev]</span><span class="delimiter">: </span><span class="description">raised cosine distribution standard deviation.</span> 71 - <span class="signature">[`variance( mu, s )`][@stdlib/stats/base/dists/cosine/variance]</span><span class="delimiter">: </span><span class="description">raised cosine distribution variance.</span> 72 73 </div> 74 75 <!-- </toc> --> 76 77 The namespace contains a constructor function for creating a [raised cosine][cosine-distribution] distribution object. 78 79 <!-- <toc pattern="*ctor*"> --> 80 81 <div class="namespace-toc"> 82 83 - <span class="signature">[`Cosine( [mu, s] )`][@stdlib/stats/base/dists/cosine/ctor]</span><span class="delimiter">: </span><span class="description">raised cosine distribution constructor.</span> 84 85 </div> 86 87 <!-- </toc> --> 88 89 ```javascript 90 var Cosine = require( '@stdlib/stats/base/dists/cosine' ).Cosine; 91 92 var dist = new Cosine( 2.0, 4.0 ); 93 94 var y = dist.cdf( 0.5 ); 95 // returns ~0.165 96 ``` 97 98 </section> 99 100 <!-- /.usage --> 101 102 <section class="examples"> 103 104 ## Examples 105 106 <!-- TODO: better examples --> 107 108 <!-- eslint no-undef: "error" --> 109 110 ```javascript 111 var objectKeys = require( '@stdlib/utils/keys' ); 112 var cosine = require( '@stdlib/stats/base/dists/cosine' ); 113 114 console.log( objectKeys( cosine ) ); 115 ``` 116 117 </section> 118 119 <!-- /.examples --> 120 121 <section class="links"> 122 123 [cosine-distribution]: https://en.wikipedia.org/wiki/Raised_cosine_distribution 124 125 <!-- <toc-links> --> 126 127 [@stdlib/stats/base/dists/cosine/ctor]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/ctor 128 129 [@stdlib/stats/base/dists/cosine/kurtosis]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/kurtosis 130 131 [@stdlib/stats/base/dists/cosine/mean]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/mean 132 133 [@stdlib/stats/base/dists/cosine/median]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/median 134 135 [@stdlib/stats/base/dists/cosine/mode]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/mode 136 137 [@stdlib/stats/base/dists/cosine/skewness]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/skewness 138 139 [@stdlib/stats/base/dists/cosine/stdev]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/stdev 140 141 [@stdlib/stats/base/dists/cosine/variance]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/variance 142 143 [@stdlib/stats/base/dists/cosine/cdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/cdf 144 145 [@stdlib/stats/base/dists/cosine/logcdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/logcdf 146 147 [@stdlib/stats/base/dists/cosine/logpdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/logpdf 148 149 [@stdlib/stats/base/dists/cosine/mgf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/mgf 150 151 [@stdlib/stats/base/dists/cosine/pdf]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/pdf 152 153 [@stdlib/stats/base/dists/cosine/quantile]: https://www.npmjs.com/package/@stdlib/stats/tree/main/base/dists/cosine/quantile 154 155 <!-- </toc-links> --> 156 157 </section> 158 159 <!-- /.links -->