## Uses of Class
org.apache.sysds.runtime.controlprogram.federated.FederatedResponse

- Packages that use FederatedResponse
  Package | Description
  --- | ---
  org.apache.sysds.hops.rewrite |
  org.apache.sysds.runtime.controlprogram.federated |
  org.apache.sysds.runtime.instructions.fed |
  org.apache.sysds.runtime.lineage |

- - ### Uses of FederatedResponse in org.apache.sysds.hops.rewrite

    Methods in org.apache.sysds.hops.rewrite that return FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `FederatedResponse` | RewriteFederatedExecution.PrivacyConstraintRetriever.`execute​(ExecutionContext ec, Data... data)` | Reads metadata JSON object, parses privacy constraint and returns the constraint in FederatedResponse.

  - ### Uses of FederatedResponse in org.apache.sysds.runtime.controlprogram.federated

    Methods in org.apache.sysds.runtime.controlprogram.federated that return FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `FederatedResponse` | FederatedStatistics.FedStatsCollectFunction.`execute​(ExecutionContext ec, Data... data)` |
    `abstract FederatedResponse` | FederatedUDF.`execute​(ExecutionContext ec, Data... data)` | Execute the user-defined function on a set of data objects (e.g., matrix objects, frame objects, or scalars), which are looked up by specified input IDs and passed in the same order.

    Methods in org.apache.sysds.runtime.controlprogram.federated that return types with arguments of type FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, boolean wait, FederatedRange[] fedRange1, FederatedRequest elseFr, FederatedRequest[] frSlices1, FederatedRequest[] frSlices2, FederatedRequest... fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, boolean wait, FederatedRange[] fedRange1, FederatedRequest elseFr, FederatedRequest frSlice1, FederatedRequest frSlice2, FederatedRequest fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, boolean wait, FederatedRequest... fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, boolean wait, FederatedRequest[] frSlices, FederatedRequest... fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, boolean wait, FederatedRequest[] frSlices1, FederatedRequest[] frSlices2, FederatedRequest... fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, FederatedRequest... fr)` |
    `Future<FederatedResponse>[]` | FederationMap.`execute​(long tid, FederatedRequest[] frSlices, FederatedRequest... fr)` |
    `static Future<FederatedResponse>` | FederatedData.`executeFederatedOperation​(InetSocketAddress address, FederatedRequest... request)` | Executes an federated operation on a federated worker.
    `Future<FederatedResponse>` | FederatedData.`executeFederatedOperation​(FederatedRequest... request)` |
    `Future<FederatedResponse>` | FederatedLocalData.`executeFederatedOperation​(FederatedRequest... request)` |
    `Future<FederatedResponse>[]` | FederationMap.`executeMultipleSlices​(long tid, boolean wait, FederatedRequest[][] frSlices, FederatedRequest[] fr)` |
    `Future<FederatedResponse>` | FederatedData.`initFederatedData​(long id)` |
    `Future<FederatedResponse>` | FederatedData.`initFederatedData​(long id, MetaData mtd)` |
    `Future<FederatedResponse>` | FederatedData.`initFederatedDataFromLocal​(long id, CacheBlock block)` |
    `List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​Future<FederatedResponse>>>` | FederationMap.`requestFederatedData()` |

    Method parameters in org.apache.sysds.runtime.controlprogram.federated with type arguments of type FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `static MatrixBlock` | FederationUtils.`aggregateResponses​(List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​Future<FederatedResponse>>> readResponses)` | Aggregate partially aggregated data from federated workers by adding values with the same index in different federated locations.
    `static MatrixBlock` | FederationUtils.`bindResponses​(List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​Future<FederatedResponse>>> readResponses, long[] dims)` | Bind data from federated workers based on non-overlapping federated ranges.
    `static void` | FederationUtils.`waitFor​(List<Future<FederatedResponse>> responses)` |

  - ### Uses of FederatedResponse in org.apache.sysds.runtime.instructions.fed

    Methods in org.apache.sysds.runtime.instructions.fed that return FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `FederatedResponse` | MultiReturnParameterizedBuiltinFEDInstruction.CreateFrameEncoder.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | MultiReturnParameterizedBuiltinFEDInstruction.ExecuteFrameEncoder.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | ParameterizedBuiltinFEDInstruction.DecodeMatrix.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | QuantilePickFEDInstruction.CreateMatrixFromFrame.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | QuantilePickFEDInstruction.GetHistogram.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | QuantilePickFEDInstruction.GetValuesInRange.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | QuantilePickFEDInstruction.GetValuesInRanges.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | QuantilePickFEDInstruction.MinMax.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | ReorgFEDInstruction.DiagMatrix.`execute​(ExecutionContext ec, Data... data)` |
    `FederatedResponse` | ReorgFEDInstruction.Rdiag.`execute​(ExecutionContext ec, Data... data)` |

  - ### Uses of FederatedResponse in org.apache.sysds.runtime.lineage

    Methods in org.apache.sysds.runtime.lineage that return FederatedResponse
    Modifier and Type | Method | Description
    --- | --- | ---
    `static FederatedResponse` | LineageCache.`reuse​(FederatedUDF udf, ExecutionContext ec)` |
    `static FederatedResponse` | LineageItemUtils.`setUDFResponse​(FederatedUDF udf, MatrixObject mo)` |