Emily Boudreaux
6b57738330
Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
179 lines
13 KiB
HTML
179 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SERiF: src/include/serif/solver/normalization/diagonal.hpp File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">SERiF<span id="projectnumber"> v0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">Stellar Evolution and Rotation in Four Dimensions</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('diagonal_8hpp.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<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">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">diagonal.hpp File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <cstddef></code><br />
|
|
<code>#include <expected></code><br />
|
|
<code>#include <span></code><br />
|
|
<code>#include <string></code><br />
|
|
<code>#include <vector></code><br />
|
|
<code>#include "<a class="el" href="base_8hpp.html">serif/discretization/blocks/base.hpp</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for diagonal.hpp:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="diagonal_8hpp__incl.svg" width="558" height="140"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="diagonal_8hpp__dep__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
|
|
</div>
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classserif_1_1solver_1_1normalization_1_1_diagonal_normalization.html">serif::solver::normalization::DiagonalNormalization</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Own the frozen, independent state and residual transformations used by one solve. <a href="classserif_1_1solver_1_1normalization_1_1_diagonal_normalization.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</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:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif.html">serif</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver.html">serif::solver</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html">serif::solver::normalization</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization_1_1detail.html">serif::solver::normalization::detail</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:aae5d65b3a0e48bfbba86a90456a7f278" id="r_aae5d65b3a0e48bfbba86a90456a7f278"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization_1_1detail.html#aae5d65b3a0e48bfbba86a90456a7f278">serif::solver::normalization::detail::require_normalization_size</a> (std::size_t received, std::size_t expected)</td></tr>
|
|
<tr class="memdesc:aae5d65b3a0e48bfbba86a90456a7f278"><td class="mdescLeft"> </td><td class="mdescRight">Require matching coordinate sizes before any output is modified. <br /></td></tr>
|
|
<tr class="separator:aae5d65b3a0e48bfbba86a90456a7f278"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0252e8da10d321a4e9e220c19884046e" id="r_a0252e8da10d321a4e9e220c19884046e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization_1_1detail.html#a0252e8da10d321a4e9e220c19884046e">serif::solver::normalization::detail::apply_normalization</a> (std::span< const double > factors, std::span< const double > input, std::span< double > output, bool inverse)</td></tr>
|
|
<tr class="memdesc:a0252e8da10d321a4e9e220c19884046e"><td class="mdescLeft"> </td><td class="mdescRight">Apply a diagonal in place or to disjoint storage, rejecting partial overlap. <br /></td></tr>
|
|
<tr class="separator:a0252e8da10d321a4e9e220c19884046e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e6459e314714cea6cad28808cd4b598" id="r_a8e6459e314714cea6cad28808cd4b598"><td class="memItemLeft" align="right" valign="top">std::expected< double, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#a8e6459e314714cea6cad28808cd4b598">serif::solver::normalization::make_riesz_factor</a> (<a class="el" href="namespaceserif_1_1discretization_1_1blocks.html#aca74ff25d2168fcdec080e03ebc023ea">discretization::blocks::RepresentedValueKind</a> kind, double metric, double physical_scale)</td></tr>
|
|
<tr class="memdesc:a8e6459e314714cea6cad28808cd4b598"><td class="mdescLeft"> </td><td class="mdescRight">Prepare one primal sqrt(metric)/scale or dual 1/(scale sqrt(metric)) factor. <br /></td></tr>
|
|
<tr class="separator:a8e6459e314714cea6cad28808cd4b598"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6e625b3ce743074b92dd17eaef58b9a" id="r_ac6e625b3ce743074b92dd17eaef58b9a"><td class="memItemLeft" align="right" valign="top">std::expected< std::vector< double >, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#ac6e625b3ce743074b92dd17eaef58b9a">serif::solver::normalization::make_riesz_factors</a> (<a class="el" href="namespaceserif_1_1discretization_1_1blocks.html#aca74ff25d2168fcdec080e03ebc023ea">discretization::blocks::RepresentedValueKind</a> kind, std::span< const double > metric, double physical_scale)</td></tr>
|
|
<tr class="memdesc:ac6e625b3ce743074b92dd17eaef58b9a"><td class="mdescLeft"> </td><td class="mdescRight">Prepare diagonal Riesz factors, reporting which coordinate has invalid data. <br /></td></tr>
|
|
<tr class="separator:ac6e625b3ce743074b92dd17eaef58b9a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabf5cac29f49d4d8d91c3f3725c8abfd" id="r_aabf5cac29f49d4d8d91c3f3725c8abfd"><td class="memItemLeft" align="right" valign="top">std::expected< <a class="el" href="classserif_1_1solver_1_1normalization_1_1_diagonal_normalization.html">DiagonalNormalization</a>, std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceserif_1_1solver_1_1normalization.html#aabf5cac29f49d4d8d91c3f3725c8abfd">serif::solver::normalization::make_diagonal_normalization</a> (std::vector< double > state, std::vector< double > residual)</td></tr>
|
|
<tr class="memdesc:aabf5cac29f49d4d8d91c3f3725c8abfd"><td class="mdescLeft"> </td><td class="mdescRight">Validate and freeze independent coordinate factors, including empty or rectangular systems. <br /></td></tr>
|
|
<tr class="separator:aabf5cac29f49d4d8d91c3f3725c8abfd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_e3fc9bd9804296f8660ca61563b995c5.html">serif</a></li><li class="navelem"><a class="el" href="dir_61ce9618cc59c903e19fcd7c3ff79031.html">solver</a></li><li class="navelem"><a class="el" href="dir_c8469baf8535e36a5f500f5e7d20760c.html">normalization</a></li><li class="navelem"><a class="el" href="diagonal_8hpp.html">diagonal.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.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|