summaryrefslogtreecommitdiff
path: root/doc/source/reference/routines.char.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/reference/routines.char.rst')
-rw-r--r--doc/source/reference/routines.char.rst88
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/source/reference/routines.char.rst b/doc/source/reference/routines.char.rst
new file mode 100644
index 000000000..2e995a772
--- /dev/null
+++ b/doc/source/reference/routines.char.rst
@@ -0,0 +1,88 @@
+String operations
+*****************
+
+.. currentmodule:: numpy.core.defchararray
+
+This module provides a set of vectorized string operations for arrays
+of type `numpy.string_` or `numpy.unicode_`. All of them are based on
+the string methods in the Python standard library.
+
+String operations
+-----------------
+
+.. autosummary::
+ :toctree: generated/
+
+ add
+ multiply
+ mod
+ capitalize
+ center
+ decode
+ encode
+ join
+ ljust
+ lower
+ lstrip
+ partition
+ replace
+ rjust
+ rpartition
+ rsplit
+ rstrip
+ split
+ splitlines
+ strip
+ swapcase
+ title
+ translate
+ upper
+ zfill
+
+Comparison
+----------
+
+Unlike the standard numpy comparison operators, the ones in the `char`
+module strip trailing whitespace characters before performing the
+comparison.
+
+.. autosummary::
+ :toctree: generated/
+
+ equal
+ not_equal
+ greater_equal
+ less_equal
+ greater
+ less
+
+String information
+------------------
+
+.. autosummary::
+ :toctree: generated/
+
+ count
+ len
+ find
+ index
+ isalpha
+ isdecimal
+ isdigit
+ islower
+ isnumeric
+ isspace
+ istitle
+ isupper
+ rfind
+ rindex
+ startswith
+
+Convenience class
+-----------------
+
+.. autosummary::
+ :toctree: generated/
+
+ chararray
+