Skip to content

Commit

Permalink
updated docs, still fidling with actions
Browse files Browse the repository at this point in the history
  • Loading branch information
@dpilger26
dpilger26 committed Jan 3, 2025
1 parent 3120f00 commit bf9e640
Show file tree
Hide file tree
Showing 1,452 changed files with 66,508 additions and 49,466 deletions.
4 changes: 2 additions & 2 deletions .github/actions/LinuxEnvironmentSetup/action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ runs:
wget https://apt.llvm.org/llvm.sh
chmod u+x llvm.sh
sed -i 's/add-apt-repository "${REPO_NAME}"/add-apt-repository -y "${REPO_NAME}"/g' llvm.sh
sudo ./llvm.sh 18
sudo ln -sfn /usr/bin/clang++-18 /usr/bin/clang++
sudo ./llvm.sh 17
sudo ln -sfn /usr/bin/clang++-17 /usr/bin/clang++
7 changes: 4 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

# NumCpp: A Templatized Header Only C++ Implementation of the [Python NumPy Library](http://www.numpy.org)

## Author: David Pilger dpilger26@gmail.com
## Author: David Pilger <dpilger26@gmail.com>

## Version: ![GitHub tag (latest by date)](https://img.shields.io/github/tag-date/dpilger26/NumCpp.svg?color=blue&label=Official%20Release&style=popout)

Expand All @@ -22,11 +22,12 @@
**C++ Standards:**
[![C++17](https://img.shields.io/badge/C%2B%2B-17-blue.svg)](https://isocpp.org/std/the-standard)
[![C++20](https://img.shields.io/badge/C%2B%2B-20-blue.svg)](https://isocpp.org/std/the-standard)
[![C++23](https://img.shields.io/badge/C%2B%2B-23-blue.svg)](https://isocpp.org/std/the-standard)

**Compilers:**
Visual Studio: 2022
GNU: 11.3
Clang: 14
GNU: 13.3
Clang: 17

**Boost Versions:**
1.73+
Expand Down
41 changes: 24 additions & 17 deletions docs/doxygen/html/_a_e_r_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=9" />
<meta name="generator" content="Doxygen 1.9.4" />
<meta name="generator" content="Doxygen 1.9.8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>NumCpp: AER.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
Expand Down Expand Up @@ -50,18 +50,18 @@
<td id="projectlogo"><img alt="Logo" src="NumCppLogoDoxygen.png" /></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">NumCpp
&#160;<span id="projectnumber">2.12.1</span>
&#160;<span id="projectnumber">2.13.0</span>
</div>
<div id="projectbrief">A Templatized Header Only C++ Implementation of the Python NumPy Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part --><!-- Generated by Doxygen 1.9.4 -->
<!-- end header part --><!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
Expand Down Expand Up @@ -101,9 +101,16 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
Expand All @@ -127,33 +134,33 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacenc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc.html">nc</a></td></tr>
<tr class="memitem:namespacenc" id="r_namespacenc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc.html">nc</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacenc_1_1coordinates"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates.html">nc::coordinates</a></td></tr>
<tr class="memitem:namespacenc_1_1coordinates" id="r_namespacenc_1_1coordinates"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates.html">nc::coordinates</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacenc_1_1coordinates_1_1reference__frames"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates_1_1reference__frames.html">nc::coordinates::reference_frames</a></td></tr>
<tr class="memitem:namespacenc_1_1coordinates_1_1reference__frames" id="r_namespacenc_1_1coordinates_1_1reference__frames"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates_1_1reference__frames.html">nc::coordinates::reference_frames</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad9877edb543e32dd160ccfb97def6fa2"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates_1_1reference__frames.html#ad9877edb543e32dd160ccfb97def6fa2">nc::coordinates::reference_frames::operator&lt;&lt;</a> (std::ostream &amp;os, const AER &amp;point)</td></tr>
<tr class="memdesc:ad9877edb543e32dd160ccfb97def6fa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stream operator. <a href="namespacenc_1_1coordinates_1_1reference__frames.html#ad9877edb543e32dd160ccfb97def6fa2">More...</a><br /></td></tr>
<tr class="memitem:ad9877edb543e32dd160ccfb97def6fa2" id="r_ad9877edb543e32dd160ccfb97def6fa2"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenc_1_1coordinates_1_1reference__frames.html#ad9877edb543e32dd160ccfb97def6fa2">nc::coordinates::reference_frames::operator&lt;&lt;</a> (std::ostream &amp;<a class="el" href="namespacenc.html#a8e78c416b2386411d8c6b5226bd4c78a">os</a>, <a class="el" href="namespacenc.html#a8e78c416b2386411d8c6b5226bd4c78a">const</a> <a class="el" href="classnc_1_1coordinates_1_1reference__frames_1_1_a_e_r.html">AER</a> &amp;<a class="el" href="namespacenc.html#a8e78c416b2386411d8c6b5226bd4c78a">point</a>)</td></tr>
<tr class="memdesc:ad9877edb543e32dd160ccfb97def6fa2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stream operator. <br /></td></tr>
<tr class="separator:ad9877edb543e32dd160ccfb97def6fa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>David Pilger <a href="#" onclick="location.href='mai'+'lto:'+'dpi'+'lg'+'er2'+'6@'+'gma'+'il'+'.co'+'m'; return false;">dpilg<span class="obfuscator">.nosp@m.</span>er26<span class="obfuscator">.nosp@m.</span>@gmai<span class="obfuscator">.nosp@m.</span>l.co<span class="obfuscator">.nosp@m.</span>m</a> <a href="https://github.com/dpilger26/NumCpp">GitHub Repository</a></dd></dl>
<p>License Copyright 2018-2023 David Pilger</p>
<p >Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :</p>
<p >The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p >THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p >Description AER Object </p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p>Description AER Object </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_34171bd951b13a53aa9f237277a18e40.html">NumCpp</a></li><li class="navelem"><a class="el" href="dir_821f0d92e31f34ac47de77ab611d6024.html">Coordinates</a></li><li class="navelem"><a class="el" href="dir_6282b7c0ec828c4b60830a3c405ff9e8.html">ReferenceFrames</a></li><li class="navelem"><a class="el" href="_a_e_r_8hpp.html">AER.hpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
Expand Down
Loading

0 comments on commit bf9e640

Please sign in to comment.