time-to-botec

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

README.md (1846B)

      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 # Gamma Delta Ratio
     22 
     23 > Compute the ratio of two [gamma][@stdlib/math/base/special/gamma] functions.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var gammaDeltaRatio = require( '@stdlib/math/base/special/gamma-delta-ratio' );
     31 ```
     32 
     33 #### gammaDeltaRatio( z, delta )
     34 
     35 Computes the ratio of two [gamma functions][@stdlib/math/base/special/gamma]. Specifically, the function evaluates `Γ( z ) / Γ( z + delta )`.
     36 
     37 ```javascript
     38 var y = gammaDeltaRatio( 2.0, 3.0 );
     39 // returns ~0.042
     40 
     41 y = gammaDeltaRatio( 4.0, 0.5 );
     42 // returns ~0.516
     43 
     44 y = gammaDeltaRatio( 100.0, 0.0 );
     45 // returns 1.0
     46 ```
     47 
     48 </section>
     49 
     50 <!-- /.usage -->
     51 
     52 <section class="examples">
     53 
     54 ## Examples
     55 
     56 <!-- eslint no-undef: "error" -->
     57 
     58 ```javascript
     59 var randu = require( '@stdlib/random/base/randu' );
     60 var gammaDeltaRatio = require( '@stdlib/math/base/special/gamma-delta-ratio' );
     61 
     62 var delta;
     63 var z;
     64 var i;
     65 
     66 for ( i = 0; i < 100; i++ ) {
     67     z = randu()*10.0;
     68     delta = randu()*10.0;
     69     console.log( 'gamma( %d ) / gamma( %d + %d ) = %d', z, z, delta, gammaDeltaRatio( z, delta ) );
     70 }
     71 ```
     72 
     73 </section>
     74 
     75 <!-- /.examples -->
     76 
     77 <section class="links">
     78 
     79 [@stdlib/math/base/special/gamma]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/gamma
     80 
     81 </section>
     82 
     83 <!-- /.links -->