84 lines
2.9 KiB
Groff
84 lines
2.9 KiB
Groff
|
.TH "serif::utils::dependencies::Resource< KeyT, StorageT, PolicyT >" 3 "Version v0.0.1a" "SERiF" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
serif::utils::dependencies::Resource< KeyT, StorageT, PolicyT >
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
.PP
|
||
|
|
\fR#include <resource\&.hpp>\fP
|
||
|
|
.SS "Public Types"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBKey\fP = KeyT"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBTarget\fP = typename StorageT::Target"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "using \fBPolicy\fP = PolicyT"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SS "Public Member Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "\fBResource\fP (StorageT storage, PolicyT \fBpolicy\fP)"
|
||
|
|
.br
|
||
|
|
.RI "Keep storage and its tracking policy together under one role key\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "const \fBTarget\fP & \fBget\fP () const"
|
||
|
|
.br
|
||
|
|
.RI "Read the resource without allowing computations to mutate their inputs\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "const PolicyT & \fBpolicy\fP () const"
|
||
|
|
.br
|
||
|
|
.RI "Expose tracking separately from the value passed to a computation\&. "
|
||
|
|
.in -1c
|
||
|
|
.SS "Private Attributes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "StorageT \fBm_storage\fP"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "PolicyT \fBm_policy\fP"
|
||
|
|
.br
|
||
|
|
.in -1c
|
||
|
|
.SH "Member Typedef Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> using \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::Key = KeyT"
|
||
|
|
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> using \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::Policy = PolicyT"
|
||
|
|
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> using \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::Target = typename StorageT::Target"
|
||
|
|
|
||
|
|
.SH "Constructor & Destructor Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::Resource (StorageT storage, PolicyT policy)\fR [inline]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Keep storage and its tracking policy together under one role key\&.
|
||
|
|
.SH "Member Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> const \fBTarget\fP & \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::get () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Read the resource without allowing computations to mutate their inputs\&.
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> const PolicyT & \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::policy () const\fR [inline]\fP, \fR [nodiscard]\fP"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Expose tracking separately from the value passed to a computation\&.
|
||
|
|
.SH "Member Data Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> PolicyT \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::m_policy\fR [private]\fP"
|
||
|
|
|
||
|
|
.SS "template<typename KeyT, typename StorageT, typename PolicyT> StorageT \fBserif::utils::dependencies::Resource\fP< KeyT, StorageT, PolicyT >::m_storage\fR [private]\fP"
|
||
|
|
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for SERiF from the source code\&.
|