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)
97 lines
4.7 KiB
Groff
97 lines
4.7 KiB
Groff
.TH "serif::solver::continuation::Family< Selected, Laws >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::solver::continuation::Family< Selected, Laws > \- Own a reusable physical family definition before selecting a target model\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <family\&.hpp>\fP
|
|
.SS "Public Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBFamily\fP (Laws laws={})"
|
|
.br
|
|
.RI "Capture dependent laws by value\&. "
|
|
.ti -1c
|
|
.RI "template<detail::LawDefinition\&.\&.\&. Added>
|
|
.br
|
|
requires \fBdetail::FamilyTraits\fP<Selected, decltype(std::tuple_cat(std::declval<Laws>(), std::declval<std::tuple<Added\&.\&.\&.>>()))>::validauto \fBwith\fP (Added\&.\&.\&. laws) const &std"
|
|
.br
|
|
.RI "Extend a copyable family without changing its independent coordinates\&. "
|
|
.ti -1c
|
|
.RI "template<typename Model, typename EquationFactory = detail::CopyEquations>
|
|
.br
|
|
requires detail::BindableFamily<Model, Selected, Laws> && std::copy_constructible<Laws> && std::invocable<const EquationFactory&, const typename Model::Equations&>auto \fBbind\fP (Model target, EquationFactory factory={}) const &"
|
|
.br
|
|
.RI "Bind a reproducible model, using an explicit factory for move-only equation definitions when necessary\&. "
|
|
.ti -1c
|
|
.RI "template<typename Model, typename EquationFactory = detail::CopyEquations>
|
|
.br
|
|
requires detail::BindableFamily<Model, Selected, Laws> && std::invocable<const EquationFactory&, const typename Model::Equations&>auto \fBbind\fP (Model target, EquationFactory factory={}) &&"
|
|
.br
|
|
.RI "Bind a target while transferring ownership of move-only laws\&. "
|
|
.in -1c
|
|
.SS "Static Private Member Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "template<typename Model, typename LawValues, typename EquationFactory> static auto \fBbind_impl\fP (Model target, LawValues &&values, EquationFactory factory)"
|
|
.br
|
|
.RI "Resolve target-dependent laws before moving their physical anchor into the family\&. "
|
|
.in -1c
|
|
.SS "Private Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "Laws \fBm_laws\fP"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<typename Selected, typename Laws>
|
|
.br
|
|
class serif::solver::continuation::Family< Selected, Laws >"Own a reusable physical family definition before selecting a target model\&.
|
|
.SH "Constructor & Destructor Documentation"
|
|
.PP
|
|
.SS "template<typename Selected, typename Laws> \fBserif::solver::continuation::Family\fP< Selected, Laws >::Family (Laws laws = \fR{}\fP)\fR [inline]\fP, \fR [explicit]\fP"
|
|
|
|
.PP
|
|
Capture dependent laws by value\&.
|
|
.SH "Member Function Documentation"
|
|
.PP
|
|
.SS "template<typename Selected, typename Laws> template<typename Model, typename EquationFactory = detail::CopyEquations>
|
|
.br
|
|
requires detail::BindableFamily<Model, Selected, Laws> && std::invocable<const EquationFactory&, const typename Model::Equations&>auto \fBserif::solver::continuation::Family\fP< Selected, Laws >::bind (Model target, EquationFactory factory = \fR{}\fP) &&\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Bind a target while transferring ownership of move-only laws\&.
|
|
.SS "template<typename Selected, typename Laws> template<typename Model, typename EquationFactory = detail::CopyEquations>
|
|
.br
|
|
requires detail::BindableFamily<Model, Selected, Laws> && std::copy_constructible<Laws> && std::invocable<const EquationFactory&, const typename Model::Equations&>auto \fBserif::solver::continuation::Family\fP< Selected, Laws >::bind (Model target, EquationFactory factory = \fR{}\fP) const &\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Bind a reproducible model, using an explicit factory for move-only equation definitions when necessary\&.
|
|
.SS "template<typename Selected, typename Laws> template<typename Model, typename LawValues, typename EquationFactory> static auto \fBserif::solver::continuation::Family\fP< Selected, Laws >::bind_impl (Model target, LawValues && values, EquationFactory factory)\fR [inline]\fP, \fR [static]\fP, \fR [nodiscard]\fP, \fR [private]\fP"
|
|
|
|
.PP
|
|
Resolve target-dependent laws before moving their physical anchor into the family\&.
|
|
.SS "template<typename Selected, typename Laws> template<detail::LawDefinition\&.\&.\&. Added>
|
|
.br
|
|
requires \fBdetail::FamilyTraits\fP<Selected, decltype(std::tuple_cat(std::declval<Laws>(), std::declval<std::tuple<Added\&.\&.\&.>>()))>::validauto \fBserif::solver::continuation::Family\fP< Selected, Laws >::with (Added\&.\&.\&. laws) const &\fR [inline]\fP, \fR [nodiscard]\fP"
|
|
|
|
.PP
|
|
Extend a copyable family without changing its independent coordinates\&. Transfer move-only law captures when extending a temporary definition\&.
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<typename Selected, typename Laws> Laws \fBserif::solver::continuation::Family\fP< Selected, Laws >::m_laws\fR [private]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|