80 lines
2.6 KiB
Groff
80 lines
2.6 KiB
Groff
|
|
.TH "serif::discretization::domain::ids::validation" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::discretization::domain::ids::validation
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.SS "Concepts"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHaveUniqueDomainIDs\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of domain IDs have unique ID values\&. This is used to ensure that no two domain IDs in a list have the same ID\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHaveUniqueBoundaryIDs\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of boundary IDs have unique ID values\&. This is used to ensure that no two boundary IDs in a list have the same ID\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHaveUniqueDomains\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of domain IDs have unique domain types\&. This is used to ensure that no two domain IDs in a list refer to the same domain type\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBHaveUniqueBoundaries\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of boundary IDs have unique boundary types\&. This is used to ensure that no two boundary IDs in a list refer to the same boundary type\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBAreDistinctDomainIDs\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of domain IDs are distinct\&. This means that each ID is a valid domain ID, no two IDs have the same integer value, and no two IDs refer to the same domain type\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "concept \fBAreDistinctBoundaryIDs\fP"
|
||
|
|
.br
|
||
|
|
.RI "Concept to check if a pack of boundary IDs are distinct\&. This means that each ID is a valid boundary ID, no two IDs have the same integer value, and no two IDs refer to the same boundary type\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "template<typename\&.\&.\&. Ts>
|
||
|
|
.br
|
||
|
|
requires (std::equality_comparable<Ts> && \&.\&.\&.)consteval bool \fBall_unique_values\fP (Ts\&.\&.\&. values) noexcept"
|
||
|
|
.br
|
||
|
|
.RI "Utility function to check if a pack of values are all unique\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename\&.\&.\&. Ts>
|
||
|
|
.br
|
||
|
|
requires (std::equality_comparable<Ts> && \&.\&.\&.)bool serif::discretization::domain::ids::validation::all_unique_values (Ts\&.\&.\&. values)\fR [nodiscard]\fP, \fR [consteval]\fP, \fR [noexcept]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Utility function to check if a pack of values are all unique\&.
|
||
|
|
.PP
|
||
|
|
\fBTemplate Parameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fITs\fP The types of the values to check\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIvalues\fP The values to check for uniqueness\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
true if all values are unique, false otherwise\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBTodo\fP
|
||
|
|
.RS 4
|
||
|
|
Really this should probably be refactored into the utils module since this is not super specific to domainIDs\&.
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|