[#BloombergLP-bslstl-Function_SmallObjectOptimization-IsInplaceFunc]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::xref:BloombergLP/bslstl/Function_SmallObjectOptimization.adoc[Function&lowbar;SmallObjectOptimization]::IsInplaceFunc
:relfileprefix: ../../../
:mrdocs:

Boolean metafunction reporting whether `FN` uses the inplace buffer&period;

== Synopsis

Declared in `&lt;bslstl&lowbar;function&lowbar;smallobjectoptimization&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class FN&gt;
struct IsInplaceFunc
    : xref:bsl/integral_constant-02.adoc[bsl::integral&lowbar;constant&lt;bool, SooFuncSize&lt;FN&gt;&colon;&colon;value &lt;&equals; sizeof(InplaceBuffer)&gt;]
----

== Description

This class is a Boolean metafunction that determines whether or not the specified `FN` template parameter should be allocated within the footprint of the `InplaceBuffer` (i&period;e&period;, using the small&hyphen;object optimization&period;)

&num; Implementation Note In the future, `InplaceFunc` should also consider the alignment of `FN` in its determination of whether or not `bsl&colon;&colon;function` will use the small&hyphen;object optimization&period; However, `bsl&colon;&colon;function` currently has no way to specify alignment when it allocates memory&period;

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:bsl/integral_constant-02.adoc[bsl::integral&lowbar;constant&lt;bool, SooFuncSize&lt;FN&gt;&colon;&colon;value &lt;&equals; sizeof(InplaceBuffer)&gt;]`
| Metafunction representing a compile&hyphen;time constant of the specified (template parameter) `t&lowbar;TYPE` with the specified (template parameter) `t&lowbar;VALUE`&period;
|===

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/type.adoc[`type`] 
| Alias for this `integral&lowbar;constant` specialization&period;
| xref:bsl/integral_constant-02/value_type.adoc[`value&lowbar;type`] 
| Alias for the (template parameter) `t&lowbar;TYPE`&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/operator_call.adoc[`operator()`] 
| Return a copy of the template argument `t&lowbar;VALUE`&period;
| xref:bsl/integral_constant-02/2conversion.adoc[`operator t&lowbar;TYPE`] 
| Return a copy of the template argument `t&lowbar;VALUE`&period;
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:bsl/integral_constant-02/value.adoc[`value`] 
| The compile&hyphen;time constant value of this metafunction&period;
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#
