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)
65 lines
2.0 KiB
Groff
65 lines
2.0 KiB
Groff
.TH "src/include/serif/geometry/deformation/detail/action_storage.hpp" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
src/include/serif/geometry/deformation/detail/action_storage.hpp
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fR#include <algorithm>\fP
|
|
.br
|
|
\fR#include <cmath>\fP
|
|
.br
|
|
\fR#include <functional>\fP
|
|
.br
|
|
\fR#include <initializer_list>\fP
|
|
.br
|
|
\fR#include <span>\fP
|
|
.br
|
|
\fR#include 'serif/geometry/deformation/failure\&.hpp'\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBserif::geometry::deformation::detail::ActionInput\fP"
|
|
.br
|
|
.RI "Pair each action input with the dimension of its mathematical space\&. "
|
|
.in -1c
|
|
.SS "Namespaces"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "namespace \fBserif\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation\fP"
|
|
.br
|
|
.ti -1c
|
|
.RI "namespace \fBserif::geometry::deformation::detail\fP"
|
|
.br
|
|
.in -1c
|
|
.SS "Functions"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::validate_deformation_values\fP (std::span< const double > values, std::size_t expected_size)"
|
|
.br
|
|
.RI "Reject incompatible lengths and non-finite values before evaluating a deformation action\&. "
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::detail::validate_disjoint_output\fP (std::span< double > output, std::initializer_list< std::span< const double > > inputs)"
|
|
.br
|
|
.RI "Preserve every action input until the last use, including nonlinear transpose derivatives\&. The list contains only the fixed number of mathematical arguments to an action; checking address intervals requires no allocation and never scans numerical coefficients\&. "
|
|
.ti -1c
|
|
.RI "\fBDeformationStatus\fP \fBserif::geometry::deformation::detail::validate_action_arguments\fP (std::span< double > output, std::size_t output_size, std::initializer_list< \fBActionInput\fP > inputs)"
|
|
.br
|
|
.RI "Validate caller buffers uniformly, retaining disjoint inputs until an action has finished\&. "
|
|
.in -1c
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|