1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
{{ header }}
.. _api.indexing:
=============
Index objects
=============
Index
-----
.. currentmodule:: pandas
**Many of these methods or variants thereof are available on the objects
that contain an index (Series/DataFrame) and those should most likely be
used before calling these methods directly.**
.. autosummary::
:toctree: api/
Index
Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.values
Index.is_monotonic
Index.is_monotonic_increasing
Index.is_monotonic_decreasing
Index.is_unique
Index.has_duplicates
Index.hasnans
Index.dtype
Index.inferred_type
Index.is_all_dates
Index.shape
Index.name
Index.names
Index.nbytes
Index.ndim
Index.size
Index.empty
Index.T
Index.memory_usage
Modifying and computations
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.all
Index.any
Index.argmin
Index.argmax
Index.copy
Index.delete
Index.drop
Index.drop_duplicates
Index.duplicated
Index.equals
Index.factorize
Index.identical
Index.insert
Index.is_
Index.is_boolean
Index.is_categorical
Index.is_floating
Index.is_integer
Index.is_interval
Index.is_mixed
Index.is_numeric
Index.is_object
Index.min
Index.max
Index.reindex
Index.rename
Index.repeat
Index.where
Index.take
Index.putmask
Index.unique
Index.nunique
Index.value_counts
Compatibility with MultiIndex
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.set_names
Index.droplevel
Missing values
~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.fillna
Index.dropna
Index.isna
Index.notna
Conversion
~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.astype
Index.item
Index.map
Index.ravel
Index.to_list
Index.to_native_types
Index.to_series
Index.to_frame
Index.view
Sorting
~~~~~~~
.. autosummary::
:toctree: api/
Index.argsort
Index.searchsorted
Index.sort_values
Time-specific operations
~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.shift
Combining / joining / set operations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
Index.append
Index.join
Index.intersection
Index.union
Index.difference
Index.symmetric_difference
Selecting
~~~~~~~~~
.. autosummary::
:toctree: api/
Index.asof
Index.asof_locs
Index.get_indexer
Index.get_indexer_for
Index.get_indexer_non_unique
Index.get_level_values
Index.get_loc
Index.get_slice_bound
Index.get_value
Index.isin
Index.slice_indexer
Index.slice_locs
.. _api.numericindex:
Numeric Index
-------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
RangeIndex
Int64Index
UInt64Index
Float64Index
.. We need this autosummary so that the methods are generated.
.. Separate block, since they aren't classes.
.. autosummary::
:toctree: api/
RangeIndex.start
RangeIndex.stop
RangeIndex.step
RangeIndex.from_range
.. _api.categoricalindex:
CategoricalIndex
----------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
CategoricalIndex
Categorical components
~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
CategoricalIndex.codes
CategoricalIndex.categories
CategoricalIndex.ordered
CategoricalIndex.rename_categories
CategoricalIndex.reorder_categories
CategoricalIndex.add_categories
CategoricalIndex.remove_categories
CategoricalIndex.remove_unused_categories
CategoricalIndex.set_categories
CategoricalIndex.as_ordered
CategoricalIndex.as_unordered
Modifying and computations
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
CategoricalIndex.map
CategoricalIndex.equals
.. _api.intervalindex:
IntervalIndex
-------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
IntervalIndex
IntervalIndex components
~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
IntervalIndex.from_arrays
IntervalIndex.from_tuples
IntervalIndex.from_breaks
IntervalIndex.left
IntervalIndex.right
IntervalIndex.mid
IntervalIndex.closed
IntervalIndex.length
IntervalIndex.values
IntervalIndex.is_empty
IntervalIndex.is_non_overlapping_monotonic
IntervalIndex.is_overlapping
IntervalIndex.get_loc
IntervalIndex.get_indexer
IntervalIndex.set_closed
IntervalIndex.contains
IntervalIndex.overlaps
IntervalIndex.to_tuples
.. _api.multiindex:
MultiIndex
----------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
MultiIndex
.. autosummary::
:toctree: api/
IndexSlice
MultiIndex constructors
~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
MultiIndex.from_arrays
MultiIndex.from_tuples
MultiIndex.from_product
MultiIndex.from_frame
MultiIndex properties
~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
MultiIndex.names
MultiIndex.levels
MultiIndex.codes
MultiIndex.nlevels
MultiIndex.levshape
MultiIndex.dtypes
MultiIndex components
~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
MultiIndex.set_levels
MultiIndex.set_codes
MultiIndex.to_flat_index
MultiIndex.to_frame
MultiIndex.sortlevel
MultiIndex.droplevel
MultiIndex.swaplevel
MultiIndex.reorder_levels
MultiIndex.remove_unused_levels
MultiIndex selecting
~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
MultiIndex.get_loc
MultiIndex.get_locs
MultiIndex.get_loc_level
MultiIndex.get_indexer
MultiIndex.get_level_values
.. _api.datetimeindex:
DatetimeIndex
-------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
DatetimeIndex
Time/date components
~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
DatetimeIndex.year
DatetimeIndex.month
DatetimeIndex.day
DatetimeIndex.hour
DatetimeIndex.minute
DatetimeIndex.second
DatetimeIndex.microsecond
DatetimeIndex.nanosecond
DatetimeIndex.date
DatetimeIndex.time
DatetimeIndex.timetz
DatetimeIndex.dayofyear
DatetimeIndex.day_of_year
DatetimeIndex.weekofyear
DatetimeIndex.week
DatetimeIndex.dayofweek
DatetimeIndex.day_of_week
DatetimeIndex.weekday
DatetimeIndex.quarter
DatetimeIndex.tz
DatetimeIndex.freq
DatetimeIndex.freqstr
DatetimeIndex.is_month_start
DatetimeIndex.is_month_end
DatetimeIndex.is_quarter_start
DatetimeIndex.is_quarter_end
DatetimeIndex.is_year_start
DatetimeIndex.is_year_end
DatetimeIndex.is_leap_year
DatetimeIndex.inferred_freq
Selecting
~~~~~~~~~
.. autosummary::
:toctree: api/
DatetimeIndex.indexer_at_time
DatetimeIndex.indexer_between_time
Time-specific operations
~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/
DatetimeIndex.normalize
DatetimeIndex.strftime
DatetimeIndex.snap
DatetimeIndex.tz_convert
DatetimeIndex.tz_localize
DatetimeIndex.round
DatetimeIndex.floor
DatetimeIndex.ceil
DatetimeIndex.month_name
DatetimeIndex.day_name
Conversion
~~~~~~~~~~
.. autosummary::
:toctree: api/
DatetimeIndex.to_period
DatetimeIndex.to_perioddelta
DatetimeIndex.to_pydatetime
DatetimeIndex.to_series
DatetimeIndex.to_frame
Methods
~~~~~~~
.. autosummary::
:toctree: api/
DatetimeIndex.mean
DatetimeIndex.std
TimedeltaIndex
--------------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
TimedeltaIndex
Components
~~~~~~~~~~
.. autosummary::
:toctree: api/
TimedeltaIndex.days
TimedeltaIndex.seconds
TimedeltaIndex.microseconds
TimedeltaIndex.nanoseconds
TimedeltaIndex.components
TimedeltaIndex.inferred_freq
Conversion
~~~~~~~~~~
.. autosummary::
:toctree: api/
TimedeltaIndex.to_pytimedelta
TimedeltaIndex.to_series
TimedeltaIndex.round
TimedeltaIndex.floor
TimedeltaIndex.ceil
TimedeltaIndex.to_frame
Methods
~~~~~~~
.. autosummary::
:toctree: api/
TimedeltaIndex.mean
.. currentmodule:: pandas
PeriodIndex
-----------
.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst
PeriodIndex
Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/
PeriodIndex.day
PeriodIndex.dayofweek
PeriodIndex.day_of_week
PeriodIndex.dayofyear
PeriodIndex.day_of_year
PeriodIndex.days_in_month
PeriodIndex.daysinmonth
PeriodIndex.end_time
PeriodIndex.freq
PeriodIndex.freqstr
PeriodIndex.hour
PeriodIndex.is_leap_year
PeriodIndex.minute
PeriodIndex.month
PeriodIndex.quarter
PeriodIndex.qyear
PeriodIndex.second
PeriodIndex.start_time
PeriodIndex.week
PeriodIndex.weekday
PeriodIndex.weekofyear
PeriodIndex.year
Methods
~~~~~~~
.. autosummary::
:toctree: api/
PeriodIndex.asfreq
PeriodIndex.strftime
PeriodIndex.to_timestamp
|