README.md (2233B)
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 # Euler-Mascheroni Constant 22 23 > The [Euler-Mascheroni][eulergamma] constant. 24 25 <section class="intro"> 26 27 The [Euler-Mascheroni][eulergamma] constant `gamma` (also known as "Euler's constant" or "the Euler constant") is defined as the limit of the sequence 28 29 <!-- <equation class="equation" label="eq:eulergamma_constant" align="center" raw="\gamma = \lim_{n\to\infty} \left( \sum_{k=1}^n \frac{1}{k} - \ln n \right)" alt="Equation for the Euler-Mascheroni constant."> --> 30 31 <div class="equation" align="center" data-raw-text="\gamma = \lim_{n\to\infty} \left( \sum_{k=1}^n \frac{1}{k} - \ln n \right)" data-equation="eq:eulergamma_constant"> 32 <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@5d87cc7cb2c58aeb732872f89562d2c89571cc8a/lib/node_modules/@stdlib/constants/float64/eulergamma/docs/img/equation_eulergamma_constant.svg" alt="Equation for the Euler-Mascheroni constant."> 33 <br> 34 </div> 35 36 <!-- </equation> --> 37 38 </section> 39 40 <!-- /.intro --> 41 42 <section class="usage"> 43 44 ## Usage 45 46 ```javascript 47 var GAMMA = require( '@stdlib/constants/float64/eulergamma' ); 48 ``` 49 50 #### GAMMA 51 52 The [Euler-Mascheroni][eulergamma] constant. 53 54 ```javascript 55 var bool = ( GAMMA === 0.5772156649015329 ); 56 // returns true 57 ``` 58 59 </section> 60 61 <!-- /.usage --> 62 63 <section class="examples"> 64 65 ## Examples 66 67 <!-- TODO: better example --> 68 69 <!-- eslint no-undef: "error" --> 70 71 ```javascript 72 var GAMMA = require( '@stdlib/constants/float64/eulergamma' ); 73 74 console.log( GAMMA ); 75 // => 0.5772156649015329 76 ``` 77 78 </section> 79 80 <!-- /.examples --> 81 82 <section class="links"> 83 84 [eulergamma]: http://mathworld.wolfram.com/Euler-MascheroniConstant.html 85 86 </section> 87 88 <!-- /.links -->