File: routines.strings.rst

package info (click to toggle)
numpy 1%3A2.3.3%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 85,940 kB
  • sloc: python: 255,476; asm: 232,483; ansic: 212,559; cpp: 157,437; f90: 1,575; sh: 845; fortran: 567; makefile: 423; sed: 139; xml: 109; java: 97; perl: 82; cs: 62; javascript: 53; objc: 33; lex: 13; yacc: 9
file content (97 lines) | stat: -rw-r--r-- 1,651 bytes parent folder | download
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
.. _routines.strings:

String functionality
====================

.. currentmodule:: numpy.strings

.. module:: numpy.strings

The `numpy.strings` module provides a set of universal functions operating
on arrays of type `numpy.str_` or `numpy.bytes_`.
For example,

.. try_examples::

   >>> np.strings.add(["num", "doc"], ["py", "umentation"])
   array(['numpy', 'documentation'], dtype='<U13')

These universal functions are also used in `numpy.char`, which provides
the `numpy.char.chararray` array subclass, in order for those routines
to get the performance benefits as well.

.. note::

   Prior to NumPy 2.0, all string functionality was in `numpy.char`, which
   only operated on fixed-width strings. That module will not be getting
   updates and will be deprecated at some point in the future.

String operations
-----------------

.. autosummary::
   :toctree: generated/

   add
   center
   capitalize
   decode
   encode
   expandtabs
   ljust
   lower
   lstrip
   mod
   multiply
   partition
   replace
   rjust
   rpartition
   rstrip
   slice
   strip
   swapcase
   title
   translate
   upper
   zfill

Comparison
----------

The `numpy.strings` module also exports the comparison universal functions
that can now operate on string arrays as well.

.. autosummary::
   :toctree: generated/

   equal
   not_equal
   greater_equal
   less_equal
   greater
   less

String information
------------------

.. autosummary::
   :toctree: generated/

   count
   endswith
   find
   index
   isalnum
   isalpha
   isdecimal
   isdigit
   islower
   isnumeric
   isspace
   istitle
   isupper
   rfind
   rindex
   startswith
   str_len