[#BloombergLP-bdlat-ArrayUtil-manipulateElementByCategory]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlat.adoc[bdlat]::xref:BloombergLP/bdlat/ArrayUtil.adoc[ArrayUtil]::manipulateElementByCategory
:relfileprefix: ../../../
:mrdocs:

Invoke a categorized manipulator on an element of the specified array.

== Synopsis

Declared in `<bdlat_arrayutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class TYPE,
    class MANIPULATOR>
static
int
manipulateElementByCategory(
    TYPE* array,
    MANIPULATOR& manipulator,
    int index);
----

== Description

Invoke the specified `manipulator` on the address of the element at the specified `index` of the specified `array` and on a prvalue of the category tag type for the dynamic category of the element. See {`bdlat_typecategory`|Category Tags and Enumerators} for documentation about category tags. Return the value from the invocation of `manipulator`. The `manipulator` must be a manipulator functor. See {`bdlat_typecategory`|`MANIPULATOR` Functors} for the requirements on `manipulator`. The behavior is undefined unless `0 <= index < bdlat_ArrayFunctions::size(array)`.

== Return Value

value from the invocation of `manipulator`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *array*
| array whose element is manipulated
| *manipulator*
| functor applied to the element with a category tag
| *index*
| zero‐based index of the element
|===


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