[#FOLLY_ASSUME_FBVECTOR_COMPATIBLE]
= FOLLY_ASSUME_FBVECTOR_COMPATIBLE
:mrdocs:

The FOLLY_ASSUME_FBVECTOR_COMPATIBLE* macros below encode the assumption that the type is relocatable per IsRelocatable above. Many types can be assumed to satisfy this condition, but it is the responsibility of the user to state that assumption. User‐defined classes will not be optimized for use with fbvector (see FBVector.h) unless they state that assumption.

== Synopsis

Declared in `<folly/Traits.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
#define FOLLY_ASSUME_FBVECTOR_COMPATIBLE(...)

----

== Description

Use FOLLY_ASSUME_FBVECTOR_COMPATIBLE with regular types like this:

FOLLY_ASSUME_FBVECTOR_COMPATIBLE(MyType)

The versions FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1, _2, _3, and _4 allow using the macro for describing templatized classes with 1, 2, 3, and 4 template parameters respectively. For template classes just use the macro with the appropriate number and pass the name of the template to it. Example:

template <class T1, class T2> class MyType { ... }; ... // Make sure you're at global scope FOLLY_ASSUME_FBVECTOR_COMPATIBLE_2(MyType)


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