MCPcopy
hub / github.com/pandas-dev/pandas / min

Method min

pandas/core/groupby/groupby.py:3156–3270  ·  view source on GitHub ↗

Compute min of group values. Parameters ---------- numeric_only : bool, default False Include only float, int, boolean columns. .. versionchanged:: 2.0.0 numeric_only no longer accepts ``None``. min_count : int, def

(
        self,
        numeric_only: bool = False,
        min_count: int = -1,
        skipna: bool = True,
        engine: Literal["cython", "numba"] | None = None,
        engine_kwargs: dict[str, bool] | None = None,
    )

Source from the content-addressed store, hash-verified

3154
3155 @final
3156 def min(
3157 self,
3158 numeric_only: bool = False,
3159 min_count: int = -1,
3160 skipna: bool = True,
3161 engine: Literal["cython", "numba"] | None = None,
3162 engine_kwargs: dict[str, bool] | None = None,
3163 ):
3164 """
3165 Compute min of group values.
3166
3167 Parameters
3168 ----------
3169 numeric_only : bool, default False
3170 Include only float, int, boolean columns.
3171
3172 .. versionchanged:: 2.0.0
3173
3174 numeric_only no longer accepts ``None``.
3175
3176 min_count : int, default -1
3177 The required number of valid values to perform the operation. If fewer
3178 than ``min_count`` non-NA values are present the result will be NA.
3179
3180 skipna : bool, default True
3181 Exclude NA/null values. If the entire group is NA and ``skipna`` is
3182 ``True``, the result will be NA.
3183
3184 .. versionchanged:: 3.0.0
3185
3186 engine : str, default None None
3187 * ``'cython'`` : Runs rolling apply through C-extensions from cython.
3188 * ``'numba'`` : Runs rolling apply through JIT compiled code from numba.
3189 Only available when ``raw`` is set to ``True``.
3190 * ``None`` : Defaults to ``'cython'`` or globally setting
3191 ``compute.use_numba``
3192
3193 engine_kwargs : dict, default None None
3194 * For ``'cython'`` engine, there are no accepted ``engine_kwargs``
3195 * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil``
3196 and ``parallel`` dictionary keys. The values must either be ``True`` or
3197 ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is
3198 ``{'nopython': True, 'nogil': False, 'parallel': False}`` and will be
3199 applied to both the ``func`` and the ``apply`` groupby aggregation.
3200
3201 Returns
3202 -------
3203 Series or DataFrame
3204 Computed min of values within each group.
3205
3206 See Also
3207 --------
3208 SeriesGroupBy.min : Return the min of the group values.
3209 DataFrameGroupBy.min : Return the min of the group values.
3210 SeriesGroupBy.max : Return the max of the group values.
3211 DataFrameGroupBy.max : Return the max of the group values.
3212 SeriesGroupBy.sum : Return the sum of the group values.
3213 DataFrameGroupBy.sum : Return the sum of the group values.

Callers

nothing calls this directly

Calls 3

_numba_agg_generalMethod · 0.95
_agg_generalMethod · 0.95
maybe_use_numbaFunction · 0.90

Tested by

no test coverage detected