RAPIDS
    Preparing search index...

    Class GroupByMultiple<T, R, IndexKey>

    Type Parameters

    • T extends TypeMap
    • R extends keyof T
    • IndexKey extends string

    Hierarchy

    • GroupByBase<T, R>
      • GroupByMultiple
    Index

    Constructors

    constructor

    Methods

    argmax argmin collectList collectSet count getGroups max mean median min nth nunique quantile std sum var

    Constructors

    Methods

    • Compute the index of the maximum value in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : Int32 },
                      R,
                  >
              )[P]
          },
      >

    • Compute the index of the minimum value in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : Int32 },
                      R,
                  >
              )[P]
          },
      >

    • Returns a list column of all included elements in the group.

      Parameters

      • Optionalinclude_nulls: boolean = true

        Whether to include/exclude nulls in list elements.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : List<T[P]> },
                      R,
                  >
              )[P]
          },
      >

    • Returns a lists column of all included elements in the group/series. Within each list, the duplicated entries are dropped out such that each entry appears only once.

      Parameters

      • Optionalinclude_nulls: boolean = true

        Whether to include/exclude nulls in list elements.

      • Optionalnulls_equal: boolean = true

        Whether null entries within each list should be considered equal.

      • Optionalnans_equal: boolean = false

        Whether NaN values in floating point column should be considered equal.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : List<T[P]> },
                      R,
                  >
              )[P]
          },
      >

    • Compute the size of each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : Int32 },
                      R,
                  >
              )[P]
          },
      >

    • Return the Groups for this GroupBy

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns Groups<Pick<T, R>, Omit<T, R>>

    • Compute the maximum value in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the average value each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the median value in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the minimum value in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Return the nth value from each group

      Parameters

      • n: number

        the index of the element to return

      • Optionalinclude_nulls: boolean = true

        Whether to include/exclude nulls in list elements.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the number of unique values in each group

      Parameters

      • Optionalinclude_nulls: boolean = false

        Whether to include/exclude nulls in list elements.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          {
                              [P in string
                              | number
                              | symbol]: Pick<
                                  {
                                      [P in (...)
                                      | (...)
                                      | (...)]: (...) extends (...) ? (...) : (...)
                                  },
                                  R,
                              >[P]
                          },
                      >
                  } & Omit<
                      { [P in string
                      | number
                      | symbol]: P extends R ? T[P] : Int32 },
                      R,
                  >
              )[P]
          },
      >

    • Return values at the given quantile.

      Parameters

      • q: number = 0.5

        the quantile to compute, 0 <= q <= 1

      • interpolation: "linear" | "lower" | "higher" | "midpoint" | "nearest" = 'linear'

        This optional parameter specifies the interpolation method to use, when the desired quantile lies between two data points i and j.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the standard deviation for each group

      Parameters

      • Optionalddof: number = 1

        Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of elements in each group.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the sum of values in each group

      Parameters

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    • Compute the variance for each group

      Parameters

      • Optionalddof: number = 1

        Delta Degrees of Freedom. The divisor used in calculations is N - ddof, where N represents the number of elements in each group.

      • OptionalmemoryResource: MemoryResource

        The optional MemoryResource used to allocate the result's device memory.

      Returns DataFrame<
          {
              [P in string]: (
                  {
                      [P in string]: Struct<
                          { [P in string
                          | number
                          | symbol]: Pick<T, R>[P] },
                      >
                  } & Omit<T, R>
              )[P]
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods