docs(docs): built docs

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)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,118 @@
.TH "serif::solver::continuation::detail" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serif::solver::continuation::detail
.SH SYNOPSIS
.br
.PP
.SS "Classes"
.in +1c
.ti -1c
.RI "struct \fBAllIdentified\fP"
.br
.ti -1c
.RI "struct \fBAllIdentified< utils::types::TypeList< Specifications\&.\&.\&. > >\fP"
.br
.ti -1c
.RI "struct \fBCatalog\fP"
.br
.ti -1c
.RI "struct \fBCatalog< Owner, std::void_t< typename SpecificationTraits< Owner >::Parameters > >\fP"
.br
.ti -1c
.RI "struct \fBContained\fP"
.br
.ti -1c
.RI "struct \fBContained< ParameterList< Parameters\&.\&.\&. >, Superset >\fP"
.br
.ti -1c
.RI "struct \fBCopyEquations\fP"
.br
.ti -1c
.RI "struct \fBFamilyTraits\fP"
.br
.ti -1c
.RI "struct \fBFamilyTraits< ParameterList< Selected\&.\&.\&. >, std::tuple< Laws\&.\&.\&. > >\fP"
.br
.ti -1c
.RI "struct \fBParameterCatalog\fP"
.br
.ti -1c
.RI "struct \fBParameterCatalog< Owner, std::void_t< typename Owner::ContinuationParameters > >\fP"
.br
.ti -1c
.RI "struct \fBRequiredDependents\fP"
.br
.ti -1c
.RI "struct \fBRequiredDependents< Parameter, std::void_t< typename Parameter::RequiredDependentParameters > >\fP"
.br
.in -1c
.SS "Concepts"
.in +1c
.ti -1c
.RI "concept \fBLawDefinition\fP"
.br
.ti -1c
.RI "concept \fBBindableFamily\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "template<typename \fBFamily\fP> std::vector< typename Family::Coordinates > \fBstarting_candidates\fP (const \fBFamily\fP &family, const \fBOptions\fP< \fBFamily\fP > &options)"
.br
.RI "Try bounded simpler starting models, unless the user explicitly fixed the starting coordinates\&. "
.ti -1c
.RI "template<typename Report, std::size_t Count> void \fBrecord\fP (\fBResult\fP< Report, Count > &result, \fBStageRecord\fP< Count > stage, std::size_t maximum)"
.br
.RI "Bound diagnostic storage while retaining total work and the newest stage\&. "
.ti -1c
.RI "template<typename \fBFamily\fP, typename Factory, typename \fBSolverOptions\fP, typename Solve> auto \fBcorrector\fP (const \fBFamily\fP &family, Factory &configure, \fBSolverOptions\fP options, Solve solve)"
.br
.RI "Adapt one fresh configured discretization per stage to the same public equilibrium solve\&. "
.ti -1c
.RI "template<typename Function> bool \fBcallable_valid\fP (const Function &value)"
.br
.RI "Reject null callable pointers even when a public aggregate bypasses its factory\&. "
.ti -1c
.RI "bool \fBvalues_agree\fP (double first, double second) noexcept"
.br
.RI "Compare independently evaluated physical laws without an absolute unit-dependent tolerance\&. "
.ti -1c
.RI "template<typename Law, typename Model> auto \fBbind_law\fP (Law &&value, const Model &target)"
.br
.RI "Bind target-dependent laws once, owning all resulting captures\&. "
.in -1c
.SH "Function Documentation"
.PP
.SS "template<typename Law, typename Model> auto serif::solver::continuation::detail::bind_law (Law && value, const Model & target)\fR [nodiscard]\fP"
.PP
Bind target-dependent laws once, owning all resulting captures\&.
.SS "template<typename Function> bool serif::solver::continuation::detail::callable_valid (const Function & value)\fR [nodiscard]\fP"
.PP
Reject null callable pointers even when a public aggregate bypasses its factory\&.
.SS "template<typename \fBFamily\fP, typename Factory, typename \fBSolverOptions\fP, typename Solve> auto serif::solver::continuation::detail::corrector (const \fBFamily\fP & family, Factory & configure, \fBSolverOptions\fP options, Solve solve)\fR [nodiscard]\fP"
.PP
Adapt one fresh configured discretization per stage to the same public equilibrium solve\&.
.SS "template<typename Report, std::size_t Count> void serif::solver::continuation::detail::record (\fBResult\fP< Report, Count > & result, \fBStageRecord\fP< Count > stage, std::size_t maximum)"
.PP
Bound diagnostic storage while retaining total work and the newest stage\&.
.SS "template<typename \fBFamily\fP> std::vector< typename Family::Coordinates > serif::solver::continuation::detail::starting_candidates (const \fBFamily\fP & family, const \fBOptions\fP< \fBFamily\fP > & options)\fR [nodiscard]\fP"
.PP
Try bounded simpler starting models, unless the user explicitly fixed the starting coordinates\&.
.SS "bool serif::solver::continuation::detail::values_agree (double first, double second)\fR [inline]\fP, \fR [nodiscard]\fP, \fR [noexcept]\fP"
.PP
Compare independently evaluated physical laws without an absolute unit-dependent tolerance\&.
.SH "Author"
.PP
Generated automatically by Doxygen for SERiF from the source code\&.