[null,null,["Last updated 2023-10-06 UTC."],[],[],null,["# tensorflow::ops::ScatterMax Class Reference\n\ntensorflow::ops::ScatterMax\n===========================\n\n`#include \u003cstate_ops.h\u003e`\n\nReduces sparse updates into a variable reference using the `max` operation.\n\nSummary\n-------\n\nThis operation computes \n\n```transact-sql\n# Scalar indices\nref[indices, ...] = max(ref[indices, ...], updates[...])\n\n# Vector indices (for each i)\nref[indices[i], ...] = max(ref[indices[i], ...], updates[i, ...])\n\n# High rank indices (for each i, ..., j)\nref[indices[i, ..., j], ...] = max(ref[indices[i, ..., j], ...], updates[i, ..., j, ...])\n```\n\n\u003cbr /\u003e\n\nThis operation outputs `ref` after the update is done. This makes it easier to chain operations that need to use the reset value.\n\nDuplicate entries are handled correctly: if multiple `indices` reference the same location, their contributions combine.\n\nRequires `updates.shape = indices.shape + ref.shape[1:]` or `updates.shape = []`.\n\n\n\u003cbr /\u003e\n\nArgs:\n\n- scope: A [Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope) object\n- ref: Should be from a [Variable](/versions/r2.14/api_docs/cc/class/tensorflow/ops/variable#classtensorflow_1_1ops_1_1_variable) node.\n- indices: A tensor of indices into the first dimension of `ref`.\n- updates: A tensor of updated values to reduce into `ref`.\n\n\u003cbr /\u003e\n\nOptional attributes (see [Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/scatter-max/attrs#structtensorflow_1_1ops_1_1_scatter_max_1_1_attrs)):\n\n- use_locking: If True, the update will be protected by a lock; otherwise the behavior is undefined, but may exhibit less contention.\n\n\u003cbr /\u003e\n\nReturns:\n\n- [Output](/versions/r2.14/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output): = Same as `ref`. Returned as a convenience for operations that want to use the updated values after the update is done.\n\n\u003cbr /\u003e\n\n| ### Constructors and Destructors ||\n|---|---|\n| [ScatterMax](#classtensorflow_1_1ops_1_1_scatter_max_1a4b1981c9ecfc07eecf70ad30681d1dc9)`(const ::`[tensorflow::Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope)` & scope, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` ref, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` indices, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` updates)` ||\n| [ScatterMax](#classtensorflow_1_1ops_1_1_scatter_max_1aea5c929e2ffcd0b4976bbedfc0903340)`(const ::`[tensorflow::Scope](/versions/r2.14/api_docs/cc/class/tensorflow/scope#classtensorflow_1_1_scope)` & scope, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` ref, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` indices, ::`[tensorflow::Input](/versions/r2.14/api_docs/cc/class/tensorflow/input#classtensorflow_1_1_input)` updates, const `[ScatterMax::Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/scatter-max/attrs#structtensorflow_1_1ops_1_1_scatter_max_1_1_attrs)` & attrs)` ||\n\n| ### Public attributes ||\n|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|\n| [operation](#classtensorflow_1_1ops_1_1_scatter_max_1a6cea238b2ed3345fd004087afbcacaa0) | [Operation](/versions/r2.14/api_docs/cc/class/tensorflow/operation#classtensorflow_1_1_operation) |\n| [output_ref](#classtensorflow_1_1ops_1_1_scatter_max_1aca68eaae434ee66a9e3be45e8e0f8856) | `::`[tensorflow::Output](/versions/r2.14/api_docs/cc/class/tensorflow/output#classtensorflow_1_1_output) |\n\n| ### Public functions ||\n|-----------------------------------------------------------------------------------------------------------------------|------------------------|\n| [node](#classtensorflow_1_1ops_1_1_scatter_max_1ad80fd35ea7dbc046710b422267f92451)`() const ` | `::tensorflow::Node *` |\n| [operator::tensorflow::Input](#classtensorflow_1_1ops_1_1_scatter_max_1a7a138a1072efbcfc196122618e9fa683)`() const ` | |\n| [operator::tensorflow::Output](#classtensorflow_1_1ops_1_1_scatter_max_1a630424d5ee3a2fffc53b48acea14c38d)`() const ` | |\n\n| ### Public static functions ||\n|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| [UseLocking](#classtensorflow_1_1ops_1_1_scatter_max_1aa62f389510e2320cf2bb0b64c40fa9db)`(bool x)` | [Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/scatter-max/attrs#structtensorflow_1_1ops_1_1_scatter_max_1_1_attrs) |\n\n| ### Structs ||\n|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| [tensorflow::ops::ScatterMax::Attrs](/versions/r2.14/api_docs/cc/struct/tensorflow/ops/scatter-max/attrs) | Optional attribute setters for [ScatterMax](/versions/r2.14/api_docs/cc/class/tensorflow/ops/scatter-max#classtensorflow_1_1ops_1_1_scatter_max). |\n\nPublic attributes\n-----------------\n\n### operation\n\n```text\nOperation operation\n``` \n\n### output_ref\n\n```scdoc\n::tensorflow::Output output_ref\n``` \n\nPublic functions\n----------------\n\n### ScatterMax\n\n```gdscript\n ScatterMax(\n const ::tensorflow::Scope & scope,\n ::tensorflow::Input ref,\n ::tensorflow::Input indices,\n ::tensorflow::Input updates\n)\n``` \n\n### ScatterMax\n\n```gdscript\n ScatterMax(\n const ::tensorflow::Scope & scope,\n ::tensorflow::Input ref,\n ::tensorflow::Input indices,\n ::tensorflow::Input updates,\n const ScatterMax::Attrs & attrs\n)\n``` \n\n### node\n\n```gdscript\n::tensorflow::Node * node() const \n``` \n\n### operator::tensorflow::Input\n\n```gdscript\n operator::tensorflow::Input() const \n``` \n\n### operator::tensorflow::Output\n\n```gdscript\n operator::tensorflow::Output() const \n``` \n\nPublic static functions\n-----------------------\n\n### UseLocking\n\n```text\nAttrs UseLocking(\n bool x\n)\n```"]]