PivotingStrategyInterface (Apache Commons Math 3.6.1 API)

org.apache.commons.math3.util

## Interface PivotingStrategyInterface

- All Known Implementing Classes:
    CentralPivotingStrategy, MedianOf3PivotingStrategy, RandomPivotingStrategy

      public interface PivotingStrategyInterface

  A strategy to pick a pivoting index of an array for doing partitioning.
  Since:
    3.4
  See Also:
    `MedianOf3PivotingStrategy`, `RandomPivotingStrategy`, `CentralPivotingStrategy`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `pivotIndex(double[] work, int begin, int end)` Find pivot index of the array so that partition and Kth element selection can be made

- - ### Method Detail

    - #### pivotIndex

          int pivotIndex(double[] work,
                       int begin,
                       int end)
                         throws MathIllegalArgumentException

      Find pivot index of the array so that partition and Kth element selection can be made
      Parameters:
        `work` - data array
        `begin` - index of the first element of the slice
        `end` - index after the last element of the slice
      Returns:
        the index of the pivot element chosen between the first and the last element of the array slice
      Throws:
        `MathIllegalArgumentException` - when indices exceeds range

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.