Skip to content

Commit a58cf5e

Browse files
DrGrafilDrGrafil
committed
0.9.0 Push
Update information on header File, Documentation and readme
1 parent 8d0d17d commit a58cf5e

12 files changed

+904
-834
lines changed

‎NISTConst/c++/NISTConst.hpp‎

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,47 @@
1+
/******************************************************************************
2+
* NISTConst 0.9.0
3+
* A constants library for physics and chemistry using data from the
4+
* National Institute of Standards and Technology (NIST).
5+
*
6+
* Based off of CODATA-2014: https://dx.doi.org/10.1063/1.4954402
7+
*------------------------------------------------------------------------
8+
* Copyright (c) 8/9/2017 Elliot M. Grafil
9+
*
10+
* Distributed under the MIT License
11+
*
12+
* Permission is hereby granted, free of charge, to any person obtaining a copy
13+
* of this software and associated documentation files (the "Software"), to deal
14+
* in the Software without restriction, including without limitation the rights
15+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16+
* copies of the Software, and to permit persons to whom the Software is
17+
* furnished to do so, subject to the following conditions:
18+
*
19+
* The above copyright notice and this permission notice shall be included in all
20+
* copies or substantial portions of the Software.
21+
22+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28+
* SOFTWARE.
29+
********************************************************************************/
30+
31+
132
/// @file NISTConst.hpp
2-
///
3-
/// @brief NIST Constants
33+
/// @brief Constants library for physics and chemistry based off of data from NIST
434
///
5-
// http://physics.nist.gov/constants
35+
/// NISTConst contains a total of 335 constants compiled by the National Institute of
36+
/// Standards and Technology (NIST) as well as their associated uncertainties.
37+
/// This library provides access to the current set of basic constants and conversion
38+
/// factors for physics and chemistry recommended by the Committee on Data for Science
39+
/// and Technology (CODATA).
40+
///
41+
/// Constants are from CODATA-2014.
42+
///
43+
/// See https://dx.doi.org/10.1063/1.4954402
44+
///
645
/// @author Elliot Grafil (Metex)
746
/// @date 8/9/17
847
/// @version 8.2.0
@@ -23,6 +62,11 @@
2362
// Following grouping done by NIST for constants
2463

2564
/// @defgroup NISTConst NIST Constants
65+
/// @brief Constants library for physics and chemistry based off of data from NIST.
66+
///
67+
/// Constants are from CODATA-2014
68+
///
69+
/// https://dx.doi.org/10.1063/1.4954402
2670

2771
/// @defgroup Universal Universal
2872
/// @ingroup NISTConst
@@ -1740,3 +1784,4 @@ namespace NISTConst
17401784
} //namespace NISTConst
17411785

17421786
#endif
1787+

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
3939
4040
3. Why does wikipedia and google disagree with some of your values?
4141
42-
It is because NISTConst values are frozen to the values present in 2014 CODATA while google and wikipedia are able to pick values from any source. An example of this is for the mass of the proton. As of 8/8/17:
42+
It is because NISTConst values are frozen to the values present in [CODATA-2014](https://dx.doi.org/10.1063/1.4954402) while google and wikipedia are able to pick values from any source. An example of this is for the mass of the proton. As of 8/8/17:
4343
4444
| Proton Mass | Source |
4545
| --- | --- |
@@ -52,12 +52,12 @@ double MassDefectInu(int const atomicNumber, int const massNumber, double massAt
5252
5353
4. The value of _____ is wrong! Can you change it to ...?
5454
55-
Check either from [HERE](https://github.com/Metex/NISTConst/blob/master/CODATA/Table%20of%20NIST%20Constant%20CODATA%202014.txt) or [HERE](https://physics.nist.gov/cuu/Constants/) before e-mailing us. NISTConst sticks stricktly to the values reported by NIST/CODATA. If NISTConst disagrees with NIST/CODATA we will change the value to be in agreement with NIST/CODATA.
55+
Check either from [HERE](https://github.com/Metex/NISTConst/blob/master/CODATA/Table%20of%20NIST%20Constant%20CODATA%202014.txt) or [HERE](https://physics.nist.gov/cuu/Constants/) or [HERE](https://dx.doi.org/10.1063/1.4954402) before e-mailing us. NISTConst sticks stricktly to the values reported by NIST/CODATA. If NISTConst disagrees with NIST/CODATA we will change the value to be in agreement with NIST/CODATA.
5656
5757
---
5858
## Release notes
5959
60-
### [NISTConst 0.8.2](https://github.com/Metex/NISTConst/releases/latest)
60+
### [NISTConst 0.9.0](https://github.com/Metex/NISTConst/releases/latest)
6161
#### Features:
6262
- Created aliases to all constants using common names and symbols.
6363
- Alias included through #define NISTCONST_COMMON_SYMBOLS_NAMES.

‎doc/html/_n_i_s_t_const_8hpp.html‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
</div><!--header-->
9393
<div class="contents">
9494

95-
<p>NIST Constants.
95+
<p>Constants library for physics and chemistry based off of data from NIST.
9696
<a href="#details">More...</a></p>
9797

9898
<p><a href="_n_i_s_t_const_8hpp_source.html">Go to the source code of this file.</a></p>
@@ -1713,7 +1713,13 @@
17131713
<tr class="separator:ga923e5bc037fee920767800b7cc9ad724"><td class="memSeparator" colspan="2">&#160;</td></tr>
17141714
</table>
17151715
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
1716-
<div class="textblock"><p>NIST Constants. </p>
1716+
<div class="textblock"><p>Constants library for physics and chemistry based off of data from NIST. </p>
1717+
<p>NISTConst contains a total of 335 constants compiled by the National Institute of Standards and Technology (NIST) as well as their associated uncertainties. This library provides access to the current set of basic constants and conversion factors for physics and chemistry recommended by the Committee on Data for Science and Technology (CODATA).</p>
1718+
<p>Constants are from CODATA-2014.</p>
1719+
<p>See <a href="https://dx.doi.org/10.1063/1.4954402">https://dx.doi.org/10.1063/1.4954402</a></p>
1720+
<dl class="section author"><dt>Author</dt><dd>Elliot Grafil (Metex) </dd></dl>
1721+
<dl class="section date"><dt>Date</dt><dd>8/9/17 </dd></dl>
1722+
<dl class="section version"><dt>Version</dt><dd>8.2.0 </dd></dl>
17171723
</div></div><!-- contents -->
17181724
</div><!-- doc-content -->
17191725
<!-- start footer part -->

‎doc/html/_n_i_s_t_const_8hpp_source.html‎

Lines changed: 807 additions & 807 deletions
Large diffs are not rendered by default.

‎doc/html/dir_fb08e4de7cb7aa63de4f78b02d2b11f2.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
9494
Files</h2></td></tr>
9595
<tr class="memitem:_n_i_s_t_const_8hpp"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_n_i_s_t_const_8hpp.html">NISTConst.hpp</a> <a href="_n_i_s_t_const_8hpp_source.html">[code]</a></td></tr>
96-
<tr class="memdesc:_n_i_s_t_const_8hpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">NIST Constants. <br /></td></tr>
96+
<tr class="memdesc:_n_i_s_t_const_8hpp"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constants library for physics and chemistry based off of data from NIST. <br /></td></tr>
9797
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
9898
</table>
9999
</div><!-- contents -->

‎doc/html/files.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
9494
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_6942ea4d37a9561c1fbd98de20e74991.html" target="_self">NISTConst</a></td><td class="desc"></td></tr>
9595
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span id="img_0_0_" class="iconfopen" onclick="toggleFolder('0_0_')">&#160;</span><a class="el" href="dir_fb08e4de7cb7aa63de4f78b02d2b11f2.html" target="_self">c++</a></td><td class="desc"></td></tr>
96-
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="_n_i_s_t_const_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="_n_i_s_t_const_8hpp.html" target="_self">NISTConst.hpp</a></td><td class="desc">NIST Constants </td></tr>
96+
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a href="_n_i_s_t_const_8hpp_source.html"><span class="icondoc"></span></a><a class="el" href="_n_i_s_t_const_8hpp.html" target="_self">NISTConst.hpp</a></td><td class="desc">Constants library for physics and chemistry based off of data from NIST </td></tr>
9797
</table>
9898
</div><!-- directory -->
9999
</div><!-- contents -->

‎doc/html/group___n_i_s_t_const.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@
9191
<div class="title">NIST Constants</div> </div>
9292
</div><!--header-->
9393
<div class="contents">
94+
95+
<p>Constants library for physics and chemistry based off of data from NIST.
96+
<a href="#details">More...</a></p>
9497
<table class="memberdecls">
9598
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
9699
Modules</h2></td></tr>
@@ -112,9 +115,9 @@
112115
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
113116
</table>
114117
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
115-
<dl class="section author"><dt>Author</dt><dd>Elliot Grafil (Metex) </dd></dl>
116-
<dl class="section date"><dt>Date</dt><dd>8/9/17 </dd></dl>
117-
<dl class="section version"><dt>Version</dt><dd>8.2.0 </dd></dl>
118+
<p>Constants library for physics and chemistry based off of data from NIST. </p>
119+
<p>Constants are from CODATA-2014</p>
120+
<p><a href="https://dx.doi.org/10.1063/1.4954402">https://dx.doi.org/10.1063/1.4954402</a> </p>
118121
</div><!-- contents -->
119122
</div><!-- doc-content -->
120123
<!-- start footer part -->

‎doc/html/modules.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
<div class="contents">
9292
<div class="textblock">Here is a list of all modules:</div><div class="directory">
9393
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
94-
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group___n_i_s_t_const.html" target="_self">NIST Constants</a></td><td class="desc"></td></tr>
94+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><a class="el" href="group___n_i_s_t_const.html" target="_self">NIST Constants</a></td><td class="desc">Constants library for physics and chemistry based off of data from NIST </td></tr>
9595
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><a class="el" href="group___universal.html" target="_self">Universal</a></td><td class="desc"></td></tr>
9696
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___impedance_of_vacuum.html" target="_self">Impedance of vacuum</a></td><td class="desc"></td></tr>
9797
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><a class="el" href="group___electric_constant.html" target="_self">Electric constant</a></td><td class="desc"></td></tr>

‎doc/latex/_n_i_s_t_const_8hpp.tex‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
\label{_n_i_s_t_const_8hpp}\index{D\+:/\+Documents/\+Git\+Hub/\+N\+I\+S\+T\+Const/\+N\+I\+S\+T\+Const/c++/\+N\+I\+S\+T\+Const.\+hpp@{D\+:/\+Documents/\+Git\+Hub/\+N\+I\+S\+T\+Const/\+N\+I\+S\+T\+Const/c++/\+N\+I\+S\+T\+Const.\+hpp}}
33

44

5-
N\+I\+ST Constants.
5+
Constants library for physics and chemistry based off of data from N\+I\+ST.
66

77

88
\subsection*{Variables}
@@ -1623,5 +1623,20 @@ \subsection*{Variables}
16231623

16241624

16251625
\subsection{Detailed Description}
1626-
N\+I\+ST Constants.
1626+
Constants library for physics and chemistry based off of data from N\+I\+ST.
16271627

1628+
N\+I\+S\+T\+Const contains a total of 335 constants compiled by the National Institute of Standards and Technology (N\+I\+ST) as well as their associated uncertainties. This library provides access to the current set of basic constants and conversion factors for physics and chemistry recommended by the Committee on Data for Science and Technology (C\+O\+D\+A\+TA).
1629+
1630+
Constants are from C\+O\+D\+A\+T\+A-\/2014.
1631+
1632+
See \href{https://dx.doi.org/10.1063/1.4954402}{\tt https\+://dx.\+doi.\+org/10.\+1063/1.\+4954402}
1633+
1634+
\begin{DoxyAuthor}{Author}
1635+
Elliot Grafil (Metex)
1636+
\end{DoxyAuthor}
1637+
\begin{DoxyDate}{Date}
1638+
8/9/17
1639+
\end{DoxyDate}
1640+
\begin{DoxyVersion}{Version}
1641+
8.\+2.\+0
1642+
\end{DoxyVersion}

‎doc/latex/dir_fb08e4de7cb7aa63de4f78b02d2b11f2.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ \subsection*{Files}
44
\begin{DoxyCompactItemize}
55
\item
66
file \hyperlink{_n_i_s_t_const_8hpp}{N\+I\+S\+T\+Const.\+hpp}
7-
\begin{DoxyCompactList}\small\item\em N\+I\+ST Constants. \end{DoxyCompactList}\end{DoxyCompactItemize}
7+
\begin{DoxyCompactList}\small\item\em Constants library for physics and chemistry based off of data from N\+I\+ST. \end{DoxyCompactList}\end{DoxyCompactItemize}

0 commit comments

Comments
 (0)