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)
74 lines
6.2 KiB
Groff
74 lines
6.2 KiB
Groff
.TH "serif::model::ScalarConstraint< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
serif::model::ScalarConstraint< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol > \- Declare independent target, unknown and residual units and stable descriptive identities\&.
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
.PP
|
|
\fR#include <specification\&.hpp>\fP
|
|
.SS "Public Types"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "using \fBTargetQuantity\fP = Target"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBCoordinateQuantity\fP = Coordinate"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBResidualQuantity\fP = Residual"
|
|
.br
|
|
.ti -1c
|
|
.RI "using \fBTargetValue\fP = \fBdimensions::QuantityValue\fP<Target>"
|
|
.br
|
|
.in -1c
|
|
.SS "Static Public Attributes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBcoordinate_id\fP {CoordinateId\&.data(), CoordinateId\&.size()}"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBcoordinate_symbol\fP {CoordinateSymbol\&.data(), CoordinateSymbol\&.size()}"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBresidual_id\fP {ResidualId\&.data(), ResidualId\&.size()}"
|
|
.br
|
|
.ti -1c
|
|
.RI "static constexpr std::string_view \fBresidual_symbol\fP {ResidualSymbol\&.data(), ResidualSymbol\&.size()}"
|
|
.br
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol>
|
|
.br
|
|
struct serif::model::ScalarConstraint< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >"Declare independent target, unknown and residual units and stable descriptive identities\&.
|
|
.SH "Member Typedef Documentation"
|
|
.PP
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> using \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::CoordinateQuantity = Coordinate"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> using \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::ResidualQuantity = Residual"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> using \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::TargetQuantity = Target"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> using \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::TargetValue = \fBdimensions::QuantityValue\fP<Target>"
|
|
|
|
.SH "Member Data Documentation"
|
|
.PP
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> std::string_view \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::coordinate_id {CoordinateId\&.data(), CoordinateId\&.size()}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> std::string_view \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::coordinate_symbol {CoordinateSymbol\&.data(), CoordinateSymbol\&.size()}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> std::string_view \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::residual_id {ResidualId\&.data(), ResidualId\&.size()}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
.SS "template<dimensions::PhysicalQuantityType Target, dimensions::PhysicalQuantityType Coordinate, dimensions::PhysicalQuantityType Residual, \fButils::types::FixedString\fP CoordinateId, \fButils::types::FixedString\fP CoordinateSymbol, \fButils::types::FixedString\fP ResidualId, \fButils::types::FixedString\fP ResidualSymbol> std::string_view \fBserif::model::ScalarConstraint\fP< Target, Coordinate, Residual, CoordinateId, CoordinateSymbol, ResidualId, ResidualSymbol >::residual_symbol {ResidualSymbol\&.data(), ResidualSymbol\&.size()}\fR [static]\fP, \fR [constexpr]\fP"
|
|
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|