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

- Packages that use FederatedRange
  Package | Description
  --- | ---
  org.apache.sysds.runtime.controlprogram.federated |
  org.apache.sysds.runtime.instructions.fed |
  org.apache.sysds.runtime.io |

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

    Methods in org.apache.sysds.runtime.controlprogram.federated that return FederatedRange
    Modifier and Type | Method | Description
    --- | --- | ---
    `FederatedRange[]` | FederationMap.`getFederatedRanges()` |
    `FederatedRange` | FederatedRange.`shift​(long rshift, long cshift)` |
    `FederatedRange` | FederatedRange.`transpose()` |

    Methods in org.apache.sysds.runtime.controlprogram.federated that return types with arguments of type FederatedRange
    Modifier and Type | Method | Description
    --- | --- | ---
    `List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>>` | FederationMap.`getMap()` |
    `List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​Future<FederatedResponse>>>` | FederationMap.`requestFederatedData()` |

    Methods in org.apache.sysds.runtime.controlprogram.federated with parameters of type FederatedRange
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | FederatedRange.`compareTo​(FederatedRange o)` |
    `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)` |

    Method parameters in org.apache.sysds.runtime.controlprogram.federated with type arguments of type FederatedRange
    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.
    `void` | FederationMap.`forEachParallel​(BiFunction<FederatedRange,​FederatedData,​Void> forEachFunction)` | Execute a function for each `FederatedRange` + `FederatedData` pair.
    `FederationMap` | FederationMap.`mapParallel​(long newVarID, BiFunction<FederatedRange,​FederatedData,​Void> mappingFunction)` | Execute a function for each `FederatedRange` + `FederatedData` pair mapping the pairs to their new form by directly changing both `FederatedRange` and `FederatedData`.

    Constructors in org.apache.sysds.runtime.controlprogram.federated with parameters of type FederatedRange
    Constructor | Description
    --- | ---
    `FederatedRange​(FederatedRange other)` | Does a deep copy of another `FederatedRange` object.
    `FederatedRange​(FederatedRange other, long clen)` |

    Constructor parameters in org.apache.sysds.runtime.controlprogram.federated with type arguments of type FederatedRange
    Constructor | Description
    --- | ---
    `FederationMap​(long ID, List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> fedMap)` |
    `FederationMap​(long ID, List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> fedMap, FTypes.FType type)` |
    `FederationMap​(List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> fedMap)` |

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

    Method parameters in org.apache.sysds.runtime.instructions.fed with type arguments of type FederatedRange
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | InitFEDInstruction.`federateFrame​(FrameObject output, List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> workers, CacheBlock[] blocks)` |
    `static void` | InitFEDInstruction.`federateMatrix​(CacheableData<?> output, List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> workers)` |
    `static void` | InitFEDInstruction.`federateMatrix​(CacheableData<?> output, List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>> workers, CacheBlock[] blocks)` |

  - ### Uses of FederatedRange in org.apache.sysds.runtime.io

    Methods in org.apache.sysds.runtime.io that return types with arguments of type FederatedRange
    Modifier and Type | Method | Description
    --- | --- | ---
    `static List<org.apache.commons.lang3.tuple.Pair<FederatedRange,​FederatedData>>` | ReaderWriterFederated.`read​(String file, DataCharacteristics mc)` | Read a federated map from disk, It is not initialized before it is used in: org.apache.sysds.runtime.instructions.fed.InitFEDInstruction