diff --git a/_sources/autoapi/arkouda/index.rst.txt b/_sources/autoapi/arkouda/index.rst.txt
index b51457010f..bc78a272a9 100644
--- a/_sources/autoapi/arkouda/index.rst.txt
+++ b/_sources/autoapi/arkouda/index.rst.txt
@@ -93,12 +93,6 @@ Classes
arkouda.Datetime
arkouda.Timedelta
arkouda.GroupBy
- arkouda.Strings
- arkouda.Datetime
- arkouda.CachedAccessor
- arkouda.Properties
- arkouda.DatetimeAccessor
- arkouda.StringAccessor
@@ -271,6 +265,9 @@ Functions
arkouda.argsort
arkouda.in1d
arkouda.coargsort
+ arkouda.convert_if_categorical
+ arkouda.generic_concat
+ arkouda.get_callback
arkouda.broadcast
arkouda.unique
arkouda.where
@@ -301,8 +298,6 @@ Functions
arkouda.isnan
arkouda.plot_dist
arkouda.hist_all
- arkouda.string_operators
- arkouda.date_operators
arkouda.get_filetype
arkouda.ls
arkouda.ls_csv
@@ -327,6 +322,13 @@ Functions
arkouda.restore
arkouda.receive
arkouda.receive_dataframe
+ arkouda.attach
+ arkouda.unregister
+ arkouda.attach_all
+ arkouda.unregister_all
+ arkouda.register_all
+ arkouda.is_registered
+ arkouda.broadcast_dims
@@ -19781,6 +19783,17 @@ Attributes
array([0, 1, 0, 1])
+.. py:function:: convert_if_categorical(values)
+
+ Convert a Categorical array to Strings for display
+
+
+.. py:function:: generic_concat(items, ordered=True)
+
+
+.. py:function:: get_callback(x)
+
+
.. py:class:: Index(values: Union[List, arkouda.pdarrayclass.pdarray, arkouda.Strings, arkouda.Categorical, pandas.Index, Index], name: Optional[str] = None)
@@ -27024,1872 +27037,224 @@ Attributes
>>> hist_all(ak_df)
-.. py:class:: Strings(strings_pdarray: arkouda.pdarrayclass.pdarray, bytes_size: arkouda.dtypes.int_scalars)
-
-
- Represents an array of strings whose data resides on the
- arkouda server. The user should not call this class directly;
- rather its instances are created by other arkouda functions.
+.. py:function:: get_filetype(filenames: Union[str, List[str]]) -> str
- .. attribute:: entry
+ Get the type of a file accessible to the server. Supported
+ file types and possible return strings are 'HDF5' and 'Parquet'.
- Encapsulation of a Segmented Strings array contained on
- the arkouda server. This is a composite of
- - offsets array: starting indices for each string
- - bytes array: raw bytes of all strings joined by nulls
+ :param filenames: A file or list of files visible to the arkouda server
+ :type filenames: Union[str, List[str]]
- :type: pdarray
+ :returns: Type of the file returned as a string, either 'HDF5', 'Parquet' or 'CSV
+ :rtype: str
- .. attribute:: size
+ :raises ValueError: Raised if filename is empty or contains only whitespace
- The number of strings in the array
+ .. rubric:: Notes
- :type: int_scalars
+ - When list provided, it is assumed that all files are the same type
+ - CSV Files without the Arkouda Header are not supported
- .. attribute:: nbytes
+ .. seealso:: :obj:`read_parquet`, :obj:`read_hdf`
- The total number of bytes in all strings
- :type: int_scalars
+.. py:function:: ls(filename: str, col_delim: str = ',', read_nested: bool = True) -> List[str]
- .. attribute:: ndim
+ This function calls the h5ls utility on a HDF5 file visible to the
+ arkouda server or calls a function that imitates the result of h5ls
+ on a Parquet file.
- The rank of the array (currently only rank 1 arrays supported)
+ :param filename: The name of the file to pass to the server
+ :type filename: str
+ :param col_delim: The delimiter used to separate columns if the file is a csv
+ :type col_delim: str
+ :param read_nested: Default True, when True, SegArray objects will be read from the file. When False,
+ SegArray (or other nested Parquet columns) will be ignored.
+ Only used for Parquet files.
+ :type read_nested: bool
- :type: int_scalars
+ :returns: The string output of the datasets from the server
+ :rtype: str
- .. attribute:: shape
+ :raises TypeError: Raised if filename is not a str
+ :raises ValueError: Raised if filename is empty or contains only whitespace
+ :raises RuntimeError: Raised if error occurs in executing ls on an HDF5 file
+ :raises Notes: - This will need to be updated because Parquet will not technically support this when we update.
+ Similar functionality will be added for Parquet in the future
+ - For CSV files without headers, please use ls_csv
- The sizes of each dimension of the array
+ .. seealso:: :obj:`ls_csv`
- :type: tuple
- .. attribute:: dtype
+.. py:function:: ls_csv(filename: str, col_delim: str = ',') -> List[str]
- The dtype is ak.str
+ Used for identifying the datasets within a file when a CSV does not
+ have a header.
- :type: dtype
+ :param filename: The name of the file to pass to the server
+ :type filename: str
+ :param col_delim: The delimiter used to separate columns if the file is a csv
+ :type col_delim: str
- .. attribute:: logger
+ :returns: The string output of the datasets from the server
+ :rtype: str
- Used for all logging operations
+ .. seealso:: :obj:`ls`
- :type: ArkoudaLogger
- .. rubric:: Notes
+.. py:function:: get_null_indices(filenames: Union[str, List[str]], datasets: Optional[Union[str, List[str]]] = None) -> Union[arkouda.pdarrayclass.pdarray, Mapping[str, arkouda.pdarrayclass.pdarray]]
- Strings is composed of two pdarrays: (1) offsets, which contains the
- starting indices for each string and (2) bytes, which contains the
- raw bytes of all strings, delimited by nulls.
+ Get null indices of a string column in a Parquet file.
- .. py:attribute:: BinOps
+ :param filenames: Either a list of filenames or shell expression
+ :type filenames: list or str
+ :param datasets: (List of) name(s) of dataset(s) to read. Each dataset must be a string
+ column. There is no default value for this function, the datasets to be
+ read must be specified.
+ :type datasets: list or str or None
-
+ :returns: * *For a single dataset returns an Arkouda pdarray and for multiple datasets*
+ * *returns a dictionary of Arkouda pdarrays* -- Dictionary of {datasetName: pdarray}
- .. py:attribute:: objType
- :value: 'Strings'
+ :raises RuntimeError: Raised if one or more of the specified files cannot be opened.
+ :raises TypeError: Raised if we receive an unknown arkouda_type returned from the server
-
+ .. seealso:: :obj:`get_datasets`, :obj:`ls`
- .. py:method:: from_return_msg(rep_msg: str) -> Strings
- :staticmethod:
- Factory method for creating a Strings object from an Arkouda server
- response message
+.. py:function:: get_datasets(filenames: Union[str, List[str]], allow_errors: bool = False, column_delim: str = ',', read_nested: bool = True) -> List[str]
- :param rep_msg: Server response message currently of form
- `created name type size ndim shape itemsize+created bytes.size 1234`
- :type rep_msg: str
+ Get the names of the datasets in the provide files
- :returns: object representing a segmented strings array on the server
- :rtype: Strings
+ :param filenames: Name of the file/s from which to return datasets
+ :type filenames: str or List[str]
+ :param allow_errors: Default: False
+ Whether or not to allow errors while accessing datasets
+ :type allow_errors: bool
+ :param column_delim: Column delimiter to be used if dataset is CSV. Otherwise, unused.
+ :type column_delim: str
+ :param read_nested: Default True, when True, SegArray objects will be read from the file. When False,
+ SegArray (or other nested Parquet columns) will be ignored.
+ Only used for Parquet Files.
+ :type read_nested: bool
- :raises RuntimeError: Raised if there's an error converting a server-returned str-descriptor
+ :rtype: List[str] of names of the datasets
- .. rubric:: Notes
+ :raises RuntimeError: - If no datasets are returned
- We really don't have an itemsize because these are variable length strings.
- In the future we could probably use this position to store the total bytes.
+ .. rubric:: Notes
+ - This function currently supports HDF5 and Parquet formats.
+ - Future updates to Parquet will deprecate this functionality on that format,
+ but similar support will be added for Parquet at that time.
+ - If a list of files is provided, only the datasets in the first file will be returned
- .. py:method:: from_parts(offset_attrib: Union[arkouda.pdarrayclass.pdarray, str], bytes_attrib: Union[arkouda.pdarrayclass.pdarray, str]) -> Strings
- :staticmethod:
+ .. seealso:: :obj:`ls`
- Factory method for creating a Strings object from an Arkouda server
- response where the arrays are separate components.
- :param offset_attrib: the array containing the offsets
- :type offset_attrib: Union[pdarray, str]
- :param bytes_attrib: the array containing the string values
- :type bytes_attrib: Union[pdarray, str]
+.. py:function:: get_columns(filenames: Union[str, List[str]], col_delim: str = ',', allow_errors: bool = False) -> List[str]
- :returns: object representing a segmented strings array on the server
- :rtype: Strings
+ Get a list of column names from CSV file(s).
- :raises RuntimeError: Raised if there's an error converting a server-returned str-descriptor
- .. rubric:: Notes
+.. py:function:: read_hdf(filenames: Union[str, List[str]], datasets: Optional[Union[str, List[str]]] = None, iterative: bool = False, strict_types: bool = True, allow_errors: bool = False, calc_string_offsets: bool = False, tag_data=False) -> Union[arkouda.pdarrayclass.pdarray, arkouda.strings.Strings, arkouda.segarray.SegArray, arkouda.array_view.ArrayView, arkouda.categorical.Categorical, arkouda.dataframe.DataFrame, arkouda.client_dtypes.IPv4, arkouda.timeclass.Datetime, arkouda.timeclass.Timedelta, arkouda.index.Index, Mapping[str, Union[arkouda.pdarrayclass.pdarray, arkouda.strings.Strings, arkouda.segarray.SegArray, arkouda.array_view.ArrayView, arkouda.categorical.Categorical, arkouda.dataframe.DataFrame, arkouda.client_dtypes.IPv4, arkouda.timeclass.Datetime, arkouda.timeclass.Timedelta, arkouda.index.Index]]]
- This factory method is used when we construct the parts of a Strings
- object on the client side and transfer the offsets & bytes separately
- to the server. This results in two entries in the symbol table and we
- need to instruct the server to assemble the into a composite entity.
+ Read Arkouda objects from HDF5 file/s
+ :param filenames: Filename/s to read objects from
+ :type filenames: str, List[str]
+ :param datasets: datasets to read from the provided files
+ :type datasets: Optional str, List[str]
+ :param iterative: Iterative (True) or Single (False) function call(s) to server
+ :type iterative: bool
+ :param strict_types: If True (default), require all dtypes of a given dataset to have the
+ same precision and sign. If False, allow dtypes of different
+ precision and sign across different files. For example, if one
+ file contains a uint32 dataset and another contains an int64
+ dataset with the same name, the contents of both will be read
+ into an int64 pdarray.
+ :type strict_types: bool
+ :param allow_errors: Default False, if True will allow files with read errors to be skipped
+ instead of failing. A warning will be included in the return containing
+ the total number of files skipped due to failure and up to 10 filenames.
+ :type allow_errors: bool
+ :param calc_string_offsets: Default False, if True this will tell the server to calculate the
+ offsets/segments array on the server versus loading them from HDF5 files.
+ In the future this option may be set to True as the default.
+ :type calc_string_offsets: bool
+ :param tagData: Default False, if True tag the data with the code associated with the filename
+ that the data was pulled from.
+ :type tagData: bool
- .. py:method:: get_lengths() -> arkouda.pdarrayclass.pdarray
+ :returns: * *For a single dataset returns an Arkouda pdarray, Arkouda Strings, Arkouda Segarrays,*
+ * *or Arkouda ArrayViews. For multiple datasets returns a dictionary of Arkouda pdarrays,*
+ * *Arkouda Strings, Arkouda Segarrays, or Arkouda ArrayViews.* -- Dictionary of {datasetName: pdarray, String, SegArray, or ArrayView}
- Return the length of each string in the array.
+ :raises ValueError: Raised if all datasets are not present in all hdf5 files or if one or
+ more of the specified files do not exist
+ :raises RuntimeError: Raised if one or more of the specified files cannot be opened.
+ If `allow_errors` is true this may be raised if no values are returned
+ from the server.
+ :raises TypeError: Raised if we receive an unknown arkouda_type returned from the server
- :returns: The length of each string
- :rtype: pdarray, int
+ .. rubric:: Notes
- :raises RuntimeError: Raised if there is a server-side error thrown
+ If filenames is a string, it is interpreted as a shell expression
+ (a single filename is a valid expression, so it will work) and is
+ expanded with glob to read all matching files.
+ If iterative == True each dataset name and file names are passed to
+ the server as independent sequential strings while if iterative == False
+ all dataset names and file names are passed to the server in a single
+ string.
- .. py:method:: get_bytes()
+ If datasets is None, infer the names of datasets from the first file
+ and read all of them. Use ``get_datasets`` to show the names of datasets
+ to HDF5 files.
- Getter for the bytes component (uint8 pdarray) of this Strings.
+ .. seealso:: :obj:`read_tagged_data`
- :returns: Pdarray of bytes of the string accessed
- :rtype: pdarray, uint8
+ .. rubric:: Examples
- .. rubric:: Example
+ >>>
+ # Read with file Extension
+ >>> x = ak.read_hdf('path/name_prefix.h5') # load HDF5
+ # Read Glob Expression
+ >>> x = ak.read_hdf('path/name_prefix*') # Reads HDF5
- >>> x = ak.array(['one', 'two', 'three'])
- >>> x.get_bytes()
- [111 110 101 0 116 119 111 0 116 104 114 101 101 0]
+.. py:function:: read_parquet(filenames: Union[str, List[str]], datasets: Optional[Union[str, List[str]]] = None, iterative: bool = False, strict_types: bool = True, allow_errors: bool = False, tag_data: bool = False, read_nested: bool = True) -> Union[arkouda.pdarrayclass.pdarray, arkouda.strings.Strings, arkouda.segarray.SegArray, arkouda.array_view.ArrayView, arkouda.categorical.Categorical, arkouda.dataframe.DataFrame, arkouda.client_dtypes.IPv4, arkouda.timeclass.Datetime, arkouda.timeclass.Timedelta, arkouda.index.Index, Mapping[str, Union[arkouda.pdarrayclass.pdarray, arkouda.strings.Strings, arkouda.segarray.SegArray, arkouda.array_view.ArrayView, arkouda.categorical.Categorical, arkouda.dataframe.DataFrame, arkouda.client_dtypes.IPv4, arkouda.timeclass.Datetime, arkouda.timeclass.Timedelta, arkouda.index.Index]]]
- .. py:method:: get_offsets()
+ Read Arkouda objects from Parquet file/s
- Getter for the offsets component (int64 pdarray) of this Strings.
+ :param filenames: Filename/s to read objects from
+ :type filenames: str, List[str]
+ :param datasets: datasets to read from the provided files
+ :type datasets: Optional str, List[str]
+ :param iterative: Iterative (True) or Single (False) function call(s) to server
+ :type iterative: bool
+ :param strict_types: If True (default), require all dtypes of a given dataset to have the
+ same precision and sign. If False, allow dtypes of different
+ precision and sign across different files. For example, if one
+ file contains a uint32 dataset and another contains an int64
+ dataset with the same name, the contents of both will be read
+ into an int64 pdarray.
+ :type strict_types: bool
+ :param allow_errors: Default False, if True will allow files with read errors to be skipped
+ instead of failing. A warning will be included in the return containing
+ the total number of files skipped due to failure and up to 10 filenames.
+ :type allow_errors: bool
+ :param tagData: Default False, if True tag the data with the code associated with the filename
+ that the data was pulled from.
+ :type tagData: bool
+ :param read_nested: Default True, when True, SegArray objects will be read from the file. When False,
+ SegArray (or other nested Parquet columns) will be ignored.
+ If datasets is not None, this will be ignored.
+ :type read_nested: bool
- :returns: Pdarray of offsets of the string accessed
- :rtype: pdarray, int64
-
- .. rubric:: Example
-
- >>> x = ak.array(['one', 'two', 'three'])
- >>> x.get_offsets()
- [0 4 8]
-
-
- .. py:method:: encode(toEncoding: str, fromEncoding: str = 'UTF-8')
-
- Return a new strings object in `toEncoding`, expecting that the
- current Strings is encoded in `fromEncoding`
-
- :param toEncoding: The encoding that the strings will be converted to
- :type toEncoding: str
- :param fromEncoding: The current encoding of the strings object, default to
- UTF-8
- :type fromEncoding: str
-
- :returns: A new Strings object in `toEncoding`
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
-
- .. py:method:: decode(fromEncoding, toEncoding='UTF-8')
-
- Return a new strings object in `fromEncoding`, expecting that the
- current Strings is encoded in `toEncoding`
-
- :param fromEncoding: The current encoding of the strings object
- :type fromEncoding: str
- :param toEncoding: The encoding that the strings will be converted to,
- default to UTF-8
- :type toEncoding: str
-
- :returns: A new Strings object in `toEncoding`
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
-
- .. py:method:: lower() -> Strings
-
- Returns a new Strings with all uppercase characters from the original replaced with
- their lowercase equivalent
-
- :returns: Strings with all uppercase characters from the original replaced with
- their lowercase equivalent
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.upper`
-
- .. rubric:: Examples
-
- >>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
- >>> strings
- array(['StrINgS 0', 'StrINgS 1', 'StrINgS 2', 'StrINgS 3', 'StrINgS 4'])
- >>> strings.lower()
- array(['strings 0', 'strings 1', 'strings 2', 'strings 3', 'strings 4'])
-
-
- .. py:method:: upper() -> Strings
-
- Returns a new Strings with all lowercase characters from the original replaced with
- their uppercase equivalent
-
- :returns: Strings with all lowercase characters from the original replaced with
- their uppercase equivalent
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.lower`
-
- .. rubric:: Examples
-
- >>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
- >>> strings
- array(['StrINgS 0', 'StrINgS 1', 'StrINgS 2', 'StrINgS 3', 'StrINgS 4'])
- >>> strings.upper()
- array(['STRINGS 0', 'STRINGS 1', 'STRINGS 2', 'STRINGS 3', 'STRINGS 4'])
-
-
- .. py:method:: title() -> Strings
-
- Returns a new Strings from the original replaced with their titlecase equivalent
-
- :returns: Strings from the original replaced with their titlecase equivalent
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.lower`, :obj:`String.upper`
-
- .. rubric:: Examples
-
- >>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
- >>> strings
- array(['StrINgS 0', 'StrINgS 1', 'StrINgS 2', 'StrINgS 3', 'StrINgS 4'])
- >>> strings.title()
- array(['Strings 0', 'Strings 1', 'Strings 2', 'Strings 3', 'Strings 4'])
-
-
- .. py:method:: islower() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings is entirely lowercase
-
- :returns: True for elements that are entirely lowercase, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.isupper`
-
- .. rubric:: Examples
-
- >>> lower = ak.array([f'strings {i}' for i in range(3)])
- >>> upper = ak.array([f'STRINGS {i}' for i in range(3)])
- >>> strings = ak.concatenate([lower, upper])
- >>> strings
- array(['strings 0', 'strings 1', 'strings 2', 'STRINGS 0', 'STRINGS 1', 'STRINGS 2'])
- >>> strings.islower()
- array([True True True False False False])
-
-
- .. py:method:: isupper() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings is entirely uppercase
-
- :returns: True for elements that are entirely uppercase, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.islower`
-
- .. rubric:: Examples
-
- >>> lower = ak.array([f'strings {i}' for i in range(3)])
- >>> upper = ak.array([f'STRINGS {i}' for i in range(3)])
- >>> strings = ak.concatenate([lower, upper])
- >>> strings
- array(['strings 0', 'strings 1', 'strings 2', 'STRINGS 0', 'STRINGS 1', 'STRINGS 2'])
- >>> strings.isupper()
- array([False False False True True True])
-
-
- .. py:method:: istitle() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings is titlecase
-
- :returns: True for elements that are titlecase, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.islower`, :obj:`Strings.isupper`
-
- .. rubric:: Examples
-
- >>> mixed = ak.array([f'sTrINgs {i}' for i in range(3)])
- >>> title = ak.array([f'Strings {i}' for i in range(3)])
- >>> strings = ak.concatenate([mixed, title])
- >>> strings
- array(['sTrINgs 0', 'sTrINgs 1', 'sTrINgs 2', 'Strings 0', 'Strings 1', 'Strings 2'])
- >>> strings.istitle()
- array([False False False True True True])
-
-
- .. py:method:: isalnum() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings is alphanumeric.
-
- :returns: True for elements that are alphanumeric, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.islower`, :obj:`Strings.isupper`, :obj:`Strings.istitle`
-
- .. rubric:: Examples
-
- >>> not_alnum = ak.array([f'%Strings {i}' for i in range(3)])
- >>> alnum = ak.array([f'Strings{i}' for i in range(3)])
- >>> strings = ak.concatenate([not_alnum, alnum])
- >>> strings
- array(['%Strings 0', '%Strings 1', '%Strings 2', 'Strings0', 'Strings1', 'Strings2'])
- >>> strings.isalnum()
- array([False False False True True True])
-
-
- .. py:method:: isalpha() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings is alphabetic. This means there is at least one character,
- and all the characters are alphabetic.
-
- :returns: True for elements that are alphabetic, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.islower`, :obj:`Strings.isupper`, :obj:`Strings.istitle`, :obj:`Strings.isalnum`
-
- .. rubric:: Examples
-
- >>> not_alpha = ak.array([f'%Strings {i}' for i in range(3)])
- >>> alpha = ak.array(['StringA','StringB','StringC'])
- >>> strings = ak.concatenate([not_alpha, alpha])
- >>> strings
- array(['%Strings 0', '%Strings 1', '%Strings 2', 'StringA','StringB','StringC'])
- >>> strings.isalpha()
- array([False False False True True True])
-
-
- .. py:method:: isdigit() -> arkouda.pdarrayclass.pdarray
-
- Returns a boolean pdarray where index i indicates whether string i of the
- Strings has all digit characters.
-
- :returns: True for elements that are digits, False otherwise
- :rtype: pdarray, bool
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.islower`, :obj:`Strings.isupper`, :obj:`Strings.istitle`
-
- .. rubric:: Examples
-
- >>> not_digit = ak.array([f'Strings {i}' for i in range(3)])
- >>> digit = ak.array([f'12{i}' for i in range(3)])
- >>> strings = ak.concatenate([not_digit, digit])
- >>> strings
- array(['Strings 0', 'Strings 1', 'Strings 2', '120', '121', '122'])
- >>> strings.isdigit()
- array([False False False True True True])
-
-
- .. py:method:: strip(chars: Optional[Union[bytes, arkouda.dtypes.str_scalars]] = '') -> Strings
-
- Returns a new Strings object with all leading and trailing occurrences of characters contained
- in chars removed. The chars argument is a string specifying the set of characters to be removed.
- If omitted, the chars argument defaults to removing whitespace. The chars argument is not a
- prefix or suffix; rather, all combinations of its values are stripped.
-
- :param chars: the set of characters to be removed
-
- :returns: Strings object with the leading and trailing characters matching the set of characters in
- the chars argument removed
- :rtype: Strings
-
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. rubric:: Examples
-
- >>> strings = ak.array(['Strings ', ' StringS ', 'StringS '])
- >>> s = strings.strip()
- >>> s
- array(['Strings', 'StringS', 'StringS'])
-
- >>> strings = ak.array(['Strings 1', '1 StringS ', ' 1StringS 12 '])
- >>> s = strings.strip(' 12')
- >>> s
- array(['Strings', 'StringS', 'StringS'])
-
-
- .. py:method:: cached_regex_patterns() -> List
-
- Returns the regex patterns for which Match objects have been cached
-
-
- .. py:method:: purge_cached_regex_patterns() -> None
-
- purges cached regex patterns
-
-
- .. py:method:: find_locations(pattern: Union[bytes, arkouda.dtypes.str_scalars]) -> Tuple[arkouda.pdarrayclass.pdarray, arkouda.pdarrayclass.pdarray, arkouda.pdarrayclass.pdarray]
-
- Finds pattern matches and returns pdarrays containing the number, start postitions,
- and lengths of matches
-
- :param pattern: The regex pattern used to find matches
- :type pattern: str_scalars
-
- :returns: * *pdarray, int64* -- For each original string, the number of pattern matches
- * *pdarray, int64* -- The start positons of pattern matches
- * *pdarray, int64* -- The lengths of pattern matches
-
- :raises TypeError: Raised if the pattern parameter is not bytes or str_scalars
- :raises ValueError: Raised if pattern is not a valid regex
- :raises RuntimeError: Raised if there is a server-side error thrown
-
- .. seealso:: :obj:`Strings.findall`, :obj:`Strings.match`
-
- .. rubric:: Examples
-
- >>> strings = ak.array([f'{i} string {i}' for i in range(1, 6)])
- >>> num_matches, starts, lens = strings.find_locations('\d')
- >>> num_matches
- array([2, 2, 2, 2, 2])
- >>> starts
- array([0, 9, 0, 9, 0, 9, 0, 9, 0, 9])
- >>> lens
- array([1, 1, 1, 1, 1, 1, 1, 1, 1, 1]))
-
-
- .. py:method:: search(pattern: Union[bytes, arkouda.dtypes.str_scalars]) -> arkouda.match.Match
-
- Returns a match object with the first location in each element where pattern produces a match.
- Elements match if any part of the string matches the regular expression pattern
-
- :param pattern: Regex used to find matches
- :type pattern: str
-
- :returns: Match object where elements match if any part of the string matches the
- regular expression pattern
- :rtype: Match
-
- .. rubric:: Examples
-
- >>> strings = ak.array(['1_2___', '____', '3', '__4___5____6___7', ''])
- >>> strings.search('_+')
- The set of category labels (determined automatically) codes (pdarray, int64) – Category indices of each value categories (Strings) – Unique category labels categories (Strings) – Unique category labels permutation (pdarray, int64) – The permutation that groups the values in the same order
as categories segments (pdarray, int64) – When values are grouped, the starting offset of each groupClasses#<
@@ -443,7 +443,7 @@ Classes#<
Classes#<
Classes#<
Classes#<
where an element of self is in test and False otherwise.
test (Union[Strings,Categorical]) – The values against which to test each value of ‘self`.
+test (Union[Strings,Categorical]) – The values against which to test each value of ‘self`.
The values self[in1d] are in the test Strings or Categorical object.
diff --git a/autoapi/arkouda/client_dtypes/index.html b/autoapi/arkouda/client_dtypes/index.html index aec960da60..e1f582b339 100644 --- a/autoapi/arkouda/client_dtypes/index.html +++ b/autoapi/arkouda/client_dtypes/index.html @@ -453,7 +453,7 @@values (pdarray or Strings) – The array of field values. If (u)int64, the values are used as-is for the +
values (pdarray or Strings) – The array of field values. If (u)int64, the values are used as-is for the binary representation of fields. If Strings, the values are converted to binary according to the mapping defined by the names and MSB_left arguments.
columns (List, tuple, pdarray, or Strings) – Column labels to use if the data does not include them. Elements must +
index (Index, pdarray, or Strings) – Index for the resulting frame. Defaults to an integer range.
columns (List, tuple, pdarray, or Strings) – Column labels to use if the data does not include them. Elements must be strings. Defaults to an stringified integer range.
pda ((list of) pdarray, Strings, or Categorical) – Input array.
pda ((list of) pdarray, Strings, or Categorical) – Input array.
return_groups (bool, optional) – If True, also return grouping information for the array.
return_indices (bool, optional) – Only applicable if return_groups is True. If True, return unique key indices along with other groups
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
segments (pdarray, int64) – Offsets of the start of each row in the sparse matrix or grouped array. Must be sorted in ascending order.
values (pdarray, Strings) – The values to broadcast, one per row (or group)
values (pdarray, Strings) – The values to broadcast, one per row (or group)
size (int) – The total number of nonzeros in the matrix. If permutation is given, this argument is ignored and the size is inferred from the permutation array.
permutation (pdarray, int64) – The permutation to go from the original ordering of nonzeros to the ordering @@ -1621,7 +1621,7 @@
The broadcast values, one per nonzero
ValueError –
The basic arkouda array class. This class contains only the
Represents an array of strings whose data resides on the
Group an array or list of arrays by value, usually in preparation
Represents an array of strings whose data resides on the
The basic arkouda array class. This class contains only the
Represents a date and/or time.
The basic arkouda array class. This class contains only the
Represents an array of strings whose data resides on the
The basic arkouda array class. This class contains only the
Represents an array of strings whose data resides on the
A DataFrame structure based on arkouda arrays.
Represents a date and/or time.
Group an array or list of arrays by value, usually in preparation
Represents an array of strings whose data resides on the
Represents a date and/or time.
Custom property-like object.
coargsort
(→ arkouda.pdarrayclass.pdarray)
Return the permutation that groups the rows (left-to-right), if the
broadcast
(segments, values[, size, permutation])
convert_if_categorical
(values)
Convert a Categorical array to Strings for display
generic_concat
(items[, ordered])
get_callback
(x)
broadcast
(segments, values[, size, permutation])
Broadcast a dense column vector to the rows of a sparse matrix or grouped array.
unique
(→ Union[groupable, Tuple[groupable, ...)
unique
(→ Union[groupable, Tuple[groupable, ...)
Find the unique elements of an array.
where
(→ Union[arkouda.pdarrayclass.pdarray, ...)
where
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Returns an array with elements chosen from A and B based upon a
arange
(→ arkouda.pdarrayclass.pdarray)
arange
(→ arkouda.pdarrayclass.pdarray)
arange([start,] stop[, stride,] dtype=int64)
full
(→ Union[arkouda.pdarrayclass.pdarray, ...)
full
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Create a pdarray filled with fill_value.
ones
(→ arkouda.pdarrayclass.pdarray)
ones
(→ arkouda.pdarrayclass.pdarray)
Create a pdarray filled with ones.
zeros
(→ arkouda.pdarrayclass.pdarray)
zeros
(→ arkouda.pdarrayclass.pdarray)
Create a pdarray filled with zeros.
concatenate
(→ Union[arkouda.pdarrayclass.pdarray, ...)
concatenate
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Concatenate a list or tuple of pdarray
or Strings
objects into
in1d
(→ Union[arkouda.pdarrayclass.pdarray, ...)
in1d
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Test whether each element of a 1-D array is also present in a second array.
argsort
(→ arkouda.pdarrayclass.pdarray)
argsort
(→ arkouda.pdarrayclass.pdarray)
Return the permutation that sorts the array.
coargsort
(→ arkouda.pdarrayclass.pdarray)
coargsort
(→ arkouda.pdarrayclass.pdarray)
Return the permutation that groups the rows (left-to-right), if the
unsqueeze
(p)
unsqueeze
(p)
zero_up
(vals)
zero_up
(vals)
Map an array of sparse values to 0-up indices.
align
(*args)
align
(*args)
Map multiple arrays of sparse identifiers to a common 0-up index.
right_align
(left, right)
right_align
(left, right)
Map two arrays of sparse values to the 0-up index set implied by the right array,
left_align
(left, right)
left_align
(left, right)
Map two arrays of sparse identifiers to the 0-up index set implied by the left array,
find
(query, space)
find
(query, space)
Return indices of query items in a search list of items (-1 if not found).
lookup
(keys, values, arguments[, fillvalue])
lookup
(keys, values, arguments[, fillvalue])
Apply the function defined by the mapping keys --> values to arguments.
in1d_intervals
(vals, intervals[, symmetric])
in1d_intervals
(vals, intervals[, symmetric])
Test each value for membership in any of a set of half-open (pythonic)
search_intervals
(vals, intervals[, tiebreak, hierarchical])
search_intervals
(vals, intervals[, tiebreak, hierarchical])
Given an array of query vals and non-overlapping, closed intervals, return
is_cosorted
(arrays)
is_cosorted
(arrays)
Return True iff the arrays are cosorted, i.e., if the arrays were columns in a table
interval_lookup
(keys, values, arguments[, fillvalue, ...])
interval_lookup
(keys, values, arguments[, fillvalue, ...])
Apply a function defined over intervals to an array of arguments.
date_range
([start, end, periods, freq, tz, normalize, ...])
date_range
([start, end, periods, freq, tz, normalize, ...])
Creates a fixed frequency Datetime range. Alias for
timedelta_range
([start, end, periods, freq, name, closed])
timedelta_range
([start, end, periods, freq, name, closed])
Return a fixed frequency TimedeltaIndex, with day as the default
skew
(→ numpy.float64)
skew
(→ numpy.float64)
Computes the sample skewness of an array.
arange
(→ arkouda.pdarrayclass.pdarray)
arange
(→ arkouda.pdarrayclass.pdarray)
arange([start,] stop[, stride,] dtype=int64)
histogram
(→ Tuple[arkouda.pdarrayclass.pdarray, ...)
histogram
(→ Tuple[arkouda.pdarrayclass.pdarray, ...)
Compute a histogram of evenly spaced bins over the range of an array.
isnan
(→ arkouda.pdarrayclass.pdarray)
isnan
(→ arkouda.pdarrayclass.pdarray)
Return the element-wise isnan check applied to the array.
plot_dist
(b, h[, log, xlabel, newfig])
plot_dist
(b, h[, log, xlabel, newfig])
Plot the distribution and cumulative distribution of histogram Data
hist_all
(ak_df[, cols])
hist_all
(ak_df[, cols])
Create a grid plot histogramming all numeric columns in ak dataframe
string_operators
(cls)
date_operators
(cls)
get_filetype
(→ str)
get_filetype
(→ str)
Get the type of a file accessible to the server. Supported
ls
(→ List[str])
ls
(→ List[str])
This function calls the h5ls utility on a HDF5 file visible to the
ls_csv
(→ List[str])
ls_csv
(→ List[str])
Used for identifying the datasets within a file when a CSV does not
get_null_indices
(→ Union[arkouda.pdarrayclass.pdarray, ...)
get_null_indices
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Get null indices of a string column in a Parquet file.
get_datasets
(→ List[str])
get_datasets
(→ List[str])
Get the names of the datasets in the provide files
get_columns
(→ List[str])
get_columns
(→ List[str])
Get a list of column names from CSV file(s).
read_hdf
(→ Union[arkouda.pdarrayclass.pdarray, ...)
read_hdf
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Read Arkouda objects from HDF5 file/s
read_parquet
(→ Union[arkouda.pdarrayclass.pdarray, ...)
read_parquet
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Read Arkouda objects from Parquet file/s
read_csv
(→ Union[arkouda.pdarrayclass.pdarray, ...)
read_csv
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Read CSV file(s) into Arkouda objects. If more than one dataset is found, the objects
read
(→ Union[arkouda.pdarrayclass.pdarray, ...)
read
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Read datasets from files.
read_tagged_data
(filenames[, datasets, strictTypes, ...])
read_tagged_data
(filenames[, datasets, strictTypes, ...])
Read datasets from files and tag each record to the file it was read from.
import_data
(read_path[, write_file, return_obj, index])
import_data
(read_path[, write_file, return_obj, index])
Import data from a file saved by Pandas (HDF5/Parquet) to Arkouda object and/or
export
(read_path[, dataset_name, write_file, ...])
export
(read_path[, dataset_name, write_file, ...])
Export data from Arkouda file (Parquet/HDF5) to Pandas object or file formatted to be
to_hdf
(→ None)
to_hdf
(→ None)
Save multiple named pdarrays to HDF5 files.
to_parquet
(→ None)
to_parquet
(→ None)
Save multiple named pdarrays to Parquet files.
to_csv
(columns, prefix_path[, names, col_delim, overwrite])
to_csv
(columns, prefix_path[, names, col_delim, overwrite])
Write Arkouda object(s) to CSV file(s). All CSV Files written by Arkouda
save_all
(→ None)
save_all
(→ None)
DEPRECATED
load
(→ Union[arkouda.pdarrayclass.pdarray, ...)
load
(→ Union[arkouda.pdarrayclass.pdarray, ...)
Load a pdarray previously saved with pdarray.save()
.
load_all
(→ Mapping[str, ...)
load_all
(→ Mapping[str, ...)
Load multiple pdarrays, Strings, SegArrays, or Categoricals previously
update_hdf
(columns, prefix_path[, names, repack])
update_hdf
(columns, prefix_path[, names, repack])
Overwrite the datasets with name appearing in names or keys in columns if columns
snapshot
(filename)
snapshot
(filename)
Create a snapshot of the current Arkouda namespace. All currently accessible variables containing
restore
(filename)
restore
(filename)
Return data saved using ak.snapshot
receive
(hostname, port)
receive
(hostname, port)
Receive a pdarray sent by pdarray.transfer().
receive_dataframe
(hostname, port)
receive_dataframe
(hostname, port)
Receive a pdarray sent by dataframe.transfer().
attach
(name)
unregister
(name)
attach_all
(names)
Attach to all objects registered with the names provide
unregister_all
(names)
Unregister all names provided
register_all
(data)
Register all objects in the provided dictionary
is_registered
(→ bool)
Determine if the name provided is associated with a registered Object
broadcast_dims
(→ Tuple[int, Ellipsis])
Algorithm to determine shape of broadcasted PD array given two array shapes
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
See also
-unregister
, attach
, unregister_groupby_by_name
, is_registered
unregister
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -2685,7 +2691,7 @@
See also
-register
, attach
, unregister_groupby_by_name
, is_registered
register
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -2711,7 +2717,7 @@
See also
-register
, attach
, unregister
, unregister_groupby_by_name
register
, attach
, unregister
, unregister_groupby_by_name
Notes
Objects registered with the server are immune to deletion until @@ -2739,7 +2745,7 @@
See also
-register
, is_registered
, unregister
, unregister_groupby_by_name
register
, is_registered
, unregister
, unregister_groupby_by_name
See also
-register
, unregister
, attach
, is_registered
register
, unregister
, attach
, is_registered
segments (pdarray, int64) – Offsets of the start of each row in the sparse matrix or grouped array. Must be sorted in ascending order.
values (pdarray, Strings) – The values to broadcast, one per row (or group)
values (pdarray, Strings) – The values to broadcast, one per row (or group)
size (int) – The total number of nonzeros in the matrix. If permutation is given, this argument is ignored and the size is inferred from the permutation array.
permutation (pdarray, int64) – The permutation to go from the original ordering of nonzeros to the ordering @@ -2796,7 +2802,7 @@
The broadcast values, one per nonzero
ValueError –
dt (np.dtype, type, or str) – The target dtype to cast values to
errors ({strict, ignore, return_validity}) –
Controls how errors are handled when casting strings to a numeric type (ignored for casts from numeric types).
@@ -2897,8 +2903,8 @@condition (pdarray) – Used to choose values from A or B
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
See also
-attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
Notes
Registered names/pdarrays in the server are immune to deletion @@ -4072,7 +4078,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -4110,7 +4116,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -4206,7 +4212,7 @@
Factory method for creating a Strings object from an Arkouda server response message
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -4450,7 +4456,7 @@Factory method for creating a Strings object from an Arkouda server response where the arrays are separate components.
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -4551,7 +4557,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -4576,7 +4582,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -4586,7 +4592,7 @@Returns a new Strings with all uppercase characters from the original replaced with their lowercase equivalent
RuntimeError – Raised if there is a server-side error thrown
@@ -4603,7 +4609,7 @@See also
- +Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -4617,7 +4623,7 @@ Attributes
-
-upper() Strings #
+upper() Strings #
Returns a new Strings with all lowercase characters from the original replaced with
their uppercase equivalent
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -4648,14 +4654,14 @@ Attributes
-
-title() Strings #
+title() Strings #
Returns a new Strings from the original replaced with their titlecase equivalent
- Returns:
Strings from the original replaced with their titlecase equivalent
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -4663,7 +4669,7 @@ Attributes
See also
-Strings.lower
, String.upper
+Strings.lower
, String.upper
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -4693,7 +4699,7 @@ Attributes
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -4725,7 +4731,7 @@ Attributes
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -4757,7 +4763,7 @@ Attributes
See also
-
+
Examples
>>> mixed = ak.array([f'sTrINgs {i}' for i in range(3)])
@@ -4789,7 +4795,7 @@ Attributes
See also
-
+
Examples
>>> not_alnum = ak.array([f'%Strings {i}' for i in range(3)])
@@ -4822,7 +4828,7 @@ Attributes
See also
-Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
+Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
Examples
>>> not_alpha = ak.array([f'%Strings {i}' for i in range(3)])
@@ -4854,7 +4860,7 @@ Attributes
See also
-
+
Examples
>>> not_digit = ak.array([f'Strings {i}' for i in range(3)])
@@ -4870,7 +4876,7 @@ Attributes
-
-strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
+strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
Returns a new Strings object with all leading and trailing occurrences of characters contained
in chars removed. The chars argument is a string specifying the set of characters to be removed.
If omitted, the chars argument defaults to removing whitespace. The chars argument is not a
@@ -4884,7 +4890,7 @@
AttributesReturn type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -5039,7 +5045,7 @@ Attributes
-
-split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
+split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
Returns a new Strings split by the occurrences of pattern.
If maxsplit is nonzero, at most maxsplit splits occur
@@ -5071,7 +5077,7 @@ Attributes
-
-findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
+findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
Return a new Strings containg all non-overlapping matches of pattern
- Parameters:
@@ -5110,7 +5116,7 @@ Attributes
-
-sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
+sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
Return new Strings obtained by replacing non-overlapping occurrences of pattern with the
replacement repl.
If count is nonzero, at most count substitutions occur
@@ -5127,7 +5133,7 @@ AttributesStrings with pattern matches replaced
- Return type:
--
+
-
- Raises:
@@ -5326,7 +5332,7 @@ Attributes
-
-flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
+flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
Unpack delimiter-joined substrings into a flat array.
- Parameters:
@@ -5405,7 +5411,7 @@ AttributesReturn type:
--
+
-
- Raises:
@@ -5468,7 +5474,7 @@ AttributesReturn type:
--
+
-
- Raises:
@@ -5496,14 +5502,14 @@ Attributes
-
-stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
+stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
Join the strings from another array onto one end of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-other (Strings) – The strings to join onto self’s strings
+other (Strings) – The strings to join onto self’s strings
delimiter (str) – String inserted between self and other
toLeft (bool) – If true, join other strings to the left of self. By default,
other is joined to the right of self.
@@ -5513,7 +5519,7 @@ AttributesThe array of joined strings
- Return type:
--
+
-
- Raises:
@@ -5539,14 +5545,14 @@ Attributes
-
-lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
+lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
Join the strings from another array onto the left of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-
@@ -5554,7 +5560,7 @@ AttributesThe array of joined strings, as other + self
- Return type:
--
+
-
- Raises:
@@ -5579,7 +5585,7 @@ Attributes
-
-get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long prefix of each string, where possible
- Parameters:
@@ -5606,7 +5612,7 @@ Attributes
-
-get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long suffix of each string, where possible
- Parameters:
@@ -5708,7 +5714,7 @@ Attributes
See also
-
+
Examples
>>> a = ak.array(["hello", "my", "world"])
@@ -6025,7 +6031,7 @@ Attributes
-
-register(user_defined_name: str) Strings #
+register(user_defined_name: str) Strings #
Register this Strings object with a user defined name in the arkouda server
so it can be attached to later using Strings.attach()
This is an in-place operation, registering a Strings object more than once will
@@ -6043,7 +6049,7 @@
AttributesReturn type:
--
+
-
- Raises:
Notes
Registered names/Strings objects in the server are immune to deletion @@ -6078,7 +6084,7 @@
See also
- +Notes
Registered names/Strings objects in the server are immune to deletion until @@ -6107,7 +6113,7 @@
class method to return a Strings object attached to the registered name in the arkouda server which was registered using register()
Notes
Registered names/Strings objects in the server are immune to deletion @@ -6144,7 +6150,7 @@
See also
- +See also
-unregister
, attach
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -6315,7 +6321,7 @@
values (pdarray or Strings) – The array of field values. If (u)int64, the values are used as-is for the +
values (pdarray or Strings) – The array of field values. If (u)int64, the values are used as-is for the binary representation of fields. If Strings, the values are converted to binary according to the mapping defined by the names and MSB_left arguments.
See also
-unregister
, attach
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -7802,7 +7808,7 @@
See also
-attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
Notes
Registered names/pdarrays in the server are immune to deletion @@ -7833,7 +7839,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -7871,7 +7877,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -8801,7 +8807,7 @@
See also
-attach
, register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
attach
, register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -8835,7 +8841,7 @@
See also
-register
, unregister
, is_registered
, list_registry
, attach
register
, unregister
, is_registered
, list_registry
, attach
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -8870,7 +8876,7 @@
pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
+pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
The indices such that pda[indices]
is sorted
arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
+arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
The indices that permute the rows to grouped order
@@ -8994,8 +9000,8 @@a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
assume_unique (bool) – If true, assume rows of a and b are each unique and sorted. By default, sort and unique them explicitly.
symmetric (bool) – Return in1d(pda1, pda2), in1d(pda2, pda1) when pda1 and 2 are single items.
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
ordered (bool) – If True (default), the arrays will be appended in the order given. If False, array data may be interleaved in blocks, which can greatly improve performance but @@ -9039,7 +9045,7 @@
Union[pdarray,Strings,Categorical]
+Union[pdarray,Strings,Categorical]
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda2 (pdarray/List) – Input array/sequence of groupable objects
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda2 (pdarray/List) – Input array/sequence of groupable objects
assume_unique (bool) – If True, the input arrays are both assumed to be unique, which can speed up the calculation. Default is False.
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda2 (pdarray/List) – Input array/sequence of groupable objects
assume_unique (bool) – If True, the input arrays are both assumed to be unique, which can speed up the calculation. Default is False.
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda1 (pdarray/Sequence[pdarray, Strings, Categorical]) – Input array/Sequence of groupable objects
pda2 (pdarray/List) – Input array/sequence of groupable objects
assume_unique (bool) – If True, the input arrays are both assumed to be unique, which can speed up the calculation. Default is False.
keys (pdarray or Strings or Categorical) – Input array of values to find the indices of in arr.
arr (pdarray or Strings or Categorical) – The values to search.
keys (pdarray or Strings or Categorical) – Input array of values to find the indices of in arr.
arr (pdarray or Strings or Categorical) – The values to search.
array of the requested size and dtype filled with fill_value
TypeError – Raised if the supplied dtype is not supported or if the size @@ -9881,7 +9887,7 @@
The array of random strings
ValueError – Raised if minlen < 0, maxlen < minlen, or size < 0
@@ -9922,7 +9928,7 @@The Strings object encapsulating a pdarray of random strings
dt (np.dtype, type, or str) – The target dtype to cast values to
errors ({strict, ignore, return_validity}) –
Controls how errors are handled when casting strings to a numeric type (ignored for casts from numeric types).
@@ -11012,7 +11018,7 @@pda (Union[pdarray, Strings, Segarray, Categorical],) – List[Union[pdarray, Strings, Segarray, Categorical]]]
pda (Union[pdarray, Strings, Segarray, Categorical],) – List[Union[pdarray, Strings, Segarray, Categorical]]]
full (bool) – This is only used when a single pdarray is passed into hash By default, a 128-bit hash is computed and returned as two int64 arrays. If full=False, then a 64-bit hash @@ -11064,8 +11070,8 @@
condition (pdarray) – Used to choose values from A or B
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
pda ((list of) pdarray, Strings, or Categorical) – Input array.
pda ((list of) pdarray, Strings, or Categorical) – Input array.
return_groups (bool, optional) – If True, also return grouping information for the array.
return_indices (bool, optional) – Only applicable if return_groups is True. If True, return unique key indices along with other groups
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
See also
-unregister
, attach
, unregister_groupby_by_name
, is_registered
unregister
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -12534,7 +12540,7 @@
See also
-register
, attach
, unregister_groupby_by_name
, is_registered
register
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -12560,7 +12566,7 @@
See also
-register
, attach
, unregister
, unregister_groupby_by_name
register
, attach
, unregister
, unregister_groupby_by_name
Notes
Objects registered with the server are immune to deletion until @@ -12588,7 +12594,7 @@
See also
-register
, is_registered
, unregister
, unregister_groupby_by_name
register
, is_registered
, unregister
, unregister_groupby_by_name
See also
- +segments (pdarray, int64) – Offsets of the start of each row in the sparse matrix or grouped array. Must be sorted in ascending order.
values (pdarray, Strings) – The values to broadcast, one per row (or group)
values (pdarray, Strings) – The values to broadcast, one per row (or group)
size (int) – The total number of nonzeros in the matrix. If permutation is given, this argument is ignored and the size is inferred from the permutation array.
permutation (pdarray, int64) – The permutation to go from the original ordering of nonzeros to the ordering @@ -12645,7 +12651,7 @@
The broadcast values, one per nonzero
ValueError –
Factory method for creating a Strings object from an Arkouda server response message
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -12810,7 +12816,7 @@Factory method for creating a Strings object from an Arkouda server response where the arrays are separate components.
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -12911,7 +12917,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -12936,7 +12942,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -12946,7 +12952,7 @@Returns a new Strings with all uppercase characters from the original replaced with their lowercase equivalent
RuntimeError – Raised if there is a server-side error thrown
@@ -12963,7 +12969,7 @@See also
- +Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -12977,7 +12983,7 @@ Return Type
-
-upper() Strings #
+upper() Strings #
Returns a new Strings with all lowercase characters from the original replaced with
their uppercase equivalent
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -13008,14 +13014,14 @@ Return Type
-
-title() Strings #
+title() Strings #
Returns a new Strings from the original replaced with their titlecase equivalent
- Returns:
Strings from the original replaced with their titlecase equivalent
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -13023,7 +13029,7 @@ Return Type
See also
-Strings.lower
, String.upper
+Strings.lower
, String.upper
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -13053,7 +13059,7 @@ Return Type
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -13085,7 +13091,7 @@ Return Type
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -13117,7 +13123,7 @@ Return Type
See also
-
+
Examples
>>> mixed = ak.array([f'sTrINgs {i}' for i in range(3)])
@@ -13149,7 +13155,7 @@ Return Type
See also
-
+
Examples
>>> not_alnum = ak.array([f'%Strings {i}' for i in range(3)])
@@ -13182,7 +13188,7 @@ Return Type
See also
-Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
+Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
Examples
>>> not_alpha = ak.array([f'%Strings {i}' for i in range(3)])
@@ -13214,7 +13220,7 @@ Return Type
See also
-
+
Examples
>>> not_digit = ak.array([f'Strings {i}' for i in range(3)])
@@ -13230,7 +13236,7 @@ Return Type
-
-strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
+strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
Returns a new Strings object with all leading and trailing occurrences of characters contained
in chars removed. The chars argument is a string specifying the set of characters to be removed.
If omitted, the chars argument defaults to removing whitespace. The chars argument is not a
@@ -13244,7 +13250,7 @@
Return TypeReturn type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -13399,7 +13405,7 @@ Return Type
-
-split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
+split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
Returns a new Strings split by the occurrences of pattern.
If maxsplit is nonzero, at most maxsplit splits occur
@@ -13431,7 +13437,7 @@ Return Type
-
-findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
+findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
Return a new Strings containg all non-overlapping matches of pattern
- Parameters:
@@ -13470,7 +13476,7 @@ Return Type
-
-sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
+sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
Return new Strings obtained by replacing non-overlapping occurrences of pattern with the
replacement repl.
If count is nonzero, at most count substitutions occur
@@ -13487,7 +13493,7 @@ Return TypeStrings with pattern matches replaced
- Return type:
--
+
-
- Raises:
@@ -13686,7 +13692,7 @@ Return Type
-
-flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
+flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
Unpack delimiter-joined substrings into a flat array.
- Parameters:
@@ -13765,7 +13771,7 @@ Return TypeReturn type:
--
+
-
- Raises:
@@ -13828,7 +13834,7 @@ Return TypeReturn type:
--
+
-
- Raises:
@@ -13856,14 +13862,14 @@ Return Type
-
-stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
+stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
Join the strings from another array onto one end of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-other (Strings) – The strings to join onto self’s strings
+other (Strings) – The strings to join onto self’s strings
delimiter (str) – String inserted between self and other
toLeft (bool) – If true, join other strings to the left of self. By default,
other is joined to the right of self.
@@ -13873,7 +13879,7 @@ Return TypeThe array of joined strings
- Return type:
--
+
-
- Raises:
@@ -13899,14 +13905,14 @@ Return Type
-
-lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
+lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
Join the strings from another array onto the left of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-
@@ -13914,7 +13920,7 @@ Return TypeThe array of joined strings, as other + self
- Return type:
--
+
-
- Raises:
@@ -13939,7 +13945,7 @@ Return Type
-
-get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long prefix of each string, where possible
- Parameters:
@@ -13966,7 +13972,7 @@ Return Type
-
-get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long suffix of each string, where possible
- Parameters:
@@ -14068,7 +14074,7 @@ Return Type
See also
-
+
Examples
>>> a = ak.array(["hello", "my", "world"])
@@ -14385,7 +14391,7 @@ Return Type
-
-register(user_defined_name: str) Strings #
+register(user_defined_name: str) Strings #
Register this Strings object with a user defined name in the arkouda server
so it can be attached to later using Strings.attach()
This is an in-place operation, registering a Strings object more than once will
@@ -14403,7 +14409,7 @@
Return TypeReturn type:
--
+
-
- Raises:
Notes
Registered names/Strings objects in the server are immune to deletion @@ -14438,7 +14444,7 @@
See also
- +Notes
Registered names/Strings objects in the server are immune to deletion until @@ -14467,7 +14473,7 @@
class method to return a Strings object attached to the registered name in the arkouda server which was registered using register()
Notes
Registered names/Strings objects in the server are immune to deletion @@ -14504,7 +14510,7 @@
See also
- +dt (np.dtype, type, or str) – The target dtype to cast values to
errors ({strict, ignore, return_validity}) –
Controls how errors are handled when casting strings to a numeric type (ignored for casts from numeric types).
@@ -15902,7 +15908,7 @@See also
-attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
Notes
Registered names/pdarrays in the server are immune to deletion @@ -15933,7 +15939,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -15971,7 +15977,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -16005,7 +16011,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -16291,7 +16297,7 @@
See also
-register
, attach
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -16318,7 +16324,7 @@
See also
-register
, attach
, unregister
Notes
Objects registered with the server are immune to deletion until @@ -16484,7 +16490,7 @@
See also
-unregister
, attach
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -16504,7 +16510,7 @@
See also
-register
, attach
, is_registered
register
, attach
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -16531,7 +16537,7 @@
See also
-register
, attach
, unregister
Notes
Objects registered with the server are immune to deletion until @@ -16747,7 +16753,7 @@
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
See also
-unregister
, attach
, unregister_groupby_by_name
, is_registered
unregister
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -17878,7 +17884,7 @@
See also
-register
, attach
, unregister_groupby_by_name
, is_registered
register
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -17904,7 +17910,7 @@
See also
-register
, attach
, unregister
, unregister_groupby_by_name
register
, attach
, unregister
, unregister_groupby_by_name
Notes
Objects registered with the server are immune to deletion until @@ -17932,7 +17938,7 @@
See also
-register
, is_registered
, unregister
, unregister_groupby_by_name
register
, is_registered
, unregister
, unregister_groupby_by_name
See also
- +segments (pdarray, int64) – Offsets of the start of each row in the sparse matrix or grouped array. Must be sorted in ascending order.
values (pdarray, Strings) – The values to broadcast, one per row (or group)
values (pdarray, Strings) – The values to broadcast, one per row (or group)
size (int) – The total number of nonzeros in the matrix. If permutation is given, this argument is ignored and the size is inferred from the permutation array.
permutation (pdarray, int64) – The permutation to go from the original ordering of nonzeros to the ordering @@ -17989,7 +17995,7 @@
The broadcast values, one per nonzero
ValueError –
See also
-attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
Notes
Registered names/pdarrays in the server are immune to deletion @@ -19270,7 +19276,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -19308,7 +19314,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -19404,7 +19410,7 @@
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
ordered (bool) – If True (default), the arrays will be appended in the order given. If False, array data may be interleaved in blocks, which can greatly improve performance but @@ -19552,7 +19558,7 @@
Union[pdarray,Strings,Categorical]
+Union[pdarray,Strings,Categorical]
Factory method for creating a Strings object from an Arkouda server response message
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -19711,7 +19717,7 @@Factory method for creating a Strings object from an Arkouda server response where the arrays are separate components.
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -19812,7 +19818,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -19837,7 +19843,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -19847,7 +19853,7 @@Returns a new Strings with all uppercase characters from the original replaced with their lowercase equivalent
RuntimeError – Raised if there is a server-side error thrown
@@ -19864,7 +19870,7 @@See also
- +Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -19878,7 +19884,7 @@ Return Type
-
-upper() Strings #
+upper() Strings #
Returns a new Strings with all lowercase characters from the original replaced with
their uppercase equivalent
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -19909,14 +19915,14 @@ Return Type
-
-title() Strings #
+title() Strings #
Returns a new Strings from the original replaced with their titlecase equivalent
- Returns:
Strings from the original replaced with their titlecase equivalent
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -19924,7 +19930,7 @@ Return Type
See also
-Strings.lower
, String.upper
+Strings.lower
, String.upper
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -19954,7 +19960,7 @@ Return Type
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -19986,7 +19992,7 @@ Return Type
See also
-
+
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -20018,7 +20024,7 @@ Return Type
See also
-
+
Examples
>>> mixed = ak.array([f'sTrINgs {i}' for i in range(3)])
@@ -20050,7 +20056,7 @@ Return Type
See also
-
+
Examples
>>> not_alnum = ak.array([f'%Strings {i}' for i in range(3)])
@@ -20083,7 +20089,7 @@ Return Type
See also
-Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
+Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
Examples
>>> not_alpha = ak.array([f'%Strings {i}' for i in range(3)])
@@ -20115,7 +20121,7 @@ Return Type
See also
-
+
Examples
>>> not_digit = ak.array([f'Strings {i}' for i in range(3)])
@@ -20131,7 +20137,7 @@ Return Type
-
-strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
+strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
Returns a new Strings object with all leading and trailing occurrences of characters contained
in chars removed. The chars argument is a string specifying the set of characters to be removed.
If omitted, the chars argument defaults to removing whitespace. The chars argument is not a
@@ -20145,7 +20151,7 @@
Return TypeReturn type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -20300,7 +20306,7 @@ Return Type
-
-split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
+split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
Returns a new Strings split by the occurrences of pattern.
If maxsplit is nonzero, at most maxsplit splits occur
@@ -20332,7 +20338,7 @@ Return Type
-
-findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
+findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
Return a new Strings containg all non-overlapping matches of pattern
- Parameters:
@@ -20371,7 +20377,7 @@ Return Type
-
-sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
+sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
Return new Strings obtained by replacing non-overlapping occurrences of pattern with the
replacement repl.
If count is nonzero, at most count substitutions occur
@@ -20388,7 +20394,7 @@ Return TypeStrings with pattern matches replaced
- Return type:
--
+
-
- Raises:
@@ -20587,7 +20593,7 @@ Return Type
-
-flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
+flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
Unpack delimiter-joined substrings into a flat array.
- Parameters:
@@ -20666,7 +20672,7 @@ Return TypeReturn type:
--
+
-
- Raises:
@@ -20729,7 +20735,7 @@ Return TypeReturn type:
--
+
-
- Raises:
@@ -20757,14 +20763,14 @@ Return Type
-
-stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
+stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
Join the strings from another array onto one end of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-other (Strings) – The strings to join onto self’s strings
+other (Strings) – The strings to join onto self’s strings
delimiter (str) – String inserted between self and other
toLeft (bool) – If true, join other strings to the left of self. By default,
other is joined to the right of self.
@@ -20774,7 +20780,7 @@ Return TypeThe array of joined strings
- Return type:
--
+
-
- Raises:
@@ -20800,14 +20806,14 @@ Return Type
-
-lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
+lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
Join the strings from another array onto the left of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-
@@ -20815,7 +20821,7 @@ Return TypeThe array of joined strings, as other + self
- Return type:
--
+
-
- Raises:
@@ -20840,7 +20846,7 @@ Return Type
-
-get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long prefix of each string, where possible
- Parameters:
@@ -20867,7 +20873,7 @@ Return Type
-
-get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long suffix of each string, where possible
- Parameters:
@@ -20969,7 +20975,7 @@ Return Type
See also
-
+
Examples
>>> a = ak.array(["hello", "my", "world"])
@@ -21286,7 +21292,7 @@ Return Type
-
-register(user_defined_name: str) Strings #
+register(user_defined_name: str) Strings #
Register this Strings object with a user defined name in the arkouda server
so it can be attached to later using Strings.attach()
This is an in-place operation, registering a Strings object more than once will
@@ -21304,7 +21310,7 @@
Return TypeReturn type:
--
+
-
- Raises:
Notes
Registered names/Strings objects in the server are immune to deletion @@ -21339,7 +21345,7 @@
See also
- +Notes
Registered names/Strings objects in the server are immune to deletion until @@ -21368,7 +21374,7 @@
class method to return a Strings object attached to the registered name in the arkouda server which was registered using register()
Notes
Registered names/Strings objects in the server are immune to deletion @@ -21405,7 +21411,7 @@
See also
- +m (list of pdarray or Strings) – List of columns, the rows of which will form the sub-arrays of the output
+m (list of pdarray or Strings) – List of columns, the rows of which will form the sub-arrays of the output
Array of rows of input
@@ -22301,7 +22307,7 @@See also
- +See also
- +See also
- +See also
- +See also
- +columns (List, tuple, pdarray, or Strings) – Column labels to use if the data does not include them. Elements must +
index (Index, pdarray, or Strings) – Index for the resulting frame. Defaults to an integer range.
columns (List, tuple, pdarray, or Strings) – Column labels to use if the data does not include them. Elements must be strings. Defaults to an stringified integer range.
See also
-unregister
, attach
, unregister_dataframe_by_name
, is_registered
unregister
, attach
, unregister_dataframe_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -23456,7 +23462,7 @@
See also
-register
, attach
, unregister_dataframe_by_name
, is_registered
register
, attach
, unregister_dataframe_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -23480,7 +23486,7 @@
See also
-register
, attach
, unregister
, unregister_dataframe_by_name
register
, attach
, unregister
, unregister_dataframe_by_name
Notes
Objects registered with the server are immune to deletion until @@ -23508,7 +23514,7 @@
See also
- +See also
- +keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
See also
-unregister
, attach
, unregister_groupby_by_name
, is_registered
unregister
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -24817,7 +24823,7 @@
See also
-register
, attach
, unregister_groupby_by_name
, is_registered
register
, attach
, unregister_groupby_by_name
, is_registered
Notes
Objects registered with the server are immune to deletion until @@ -24843,7 +24849,7 @@
See also
-register
, attach
, unregister
, unregister_groupby_by_name
register
, attach
, unregister
, unregister_groupby_by_name
Notes
Objects registered with the server are immune to deletion until @@ -24871,7 +24877,7 @@
See also
-register
, is_registered
, unregister
, unregister_groupby_by_name
register
, is_registered
, unregister
, unregister_groupby_by_name
See also
- +pda ((list of) pdarray, Strings, or Categorical) – Input array.
pda ((list of) pdarray, Strings, or Categorical) – Input array.
return_groups (bool, optional) – If True, also return grouping information for the array.
return_indices (bool, optional) – Only applicable if return_groups is True. If True, return unique key indices along with other groups
dt (np.dtype, type, or str) – The target dtype to cast values to
errors ({strict, ignore, return_validity}) –
Controls how errors are handled when casting strings to a numeric type (ignored for casts from numeric types).
@@ -26090,7 +26096,7 @@See also
-attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
attach
, unregister
, is_registered
, list_registry
, unregister_pdarray_by_name
Notes
Registered names/pdarrays in the server are immune to deletion @@ -26121,7 +26127,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -26159,7 +26165,7 @@
See also
-register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
register
, unregister
, is_registered
, unregister_pdarray_by_name
, list_registry
Notes
Registered names/pdarrays in the server are immune to deletion @@ -26255,7 +26261,7 @@
pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
+pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
The indices such that pda[indices]
is sorted
a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
assume_unique (bool) – If true, assume rows of a and b are each unique and sorted. By default, sort and unique them explicitly.
symmetric (bool) – Return in1d(pda1, pda2), in1d(pda2, pda1) when pda1 and 2 are single items.
arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
+arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
The indices that permute the rows to grouped order
@@ -26484,9 +26490,25 @@Convert a Categorical array to Strings for display
+Notes
Objects registered with the server are immune to deletion until @@ -26589,7 +26611,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -26616,7 +26638,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -26933,7 +26955,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -26953,7 +26975,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -26980,7 +27002,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -27093,7 +27115,7 @@
index (pdarray, Strings) – an array of indices associated with the data array. +
index (pdarray, Strings) – an array of indices associated with the data array. If empty, it will default to a range of ints whose size match the size of the data. optional
data (Tuple, List, groupable_element_type) – a 1D array. Must not be None.
Accesses entries of a Series by label
Accesses entries of a Series by label
key (Series, pdarray, Strings, Categorical, List, supported_scalars) – The key or container of keys that might be used to index into the Series.
+key (Series, pdarray, Strings, Categorical, List, supported_scalars) – The key or container of keys that might be used to index into the Series.
The validated key(s), with lists and tuples converted to pdarrays
@@ -27221,7 +27243,7 @@val (pdarray, Strings, list, supported_scalars) – The value or container of values that might be assigned into the Series.
+val (pdarray, Strings, list, supported_scalars) – The value or container of values that might be assigned into the Series.
The validated value, with lists converted to pdarrays
@@ -27408,7 +27430,7 @@Notes
Objects registered with the server are immune to deletion until @@ -27428,7 +27450,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -27470,7 +27492,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -27587,7 +27609,7 @@
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
keys ((list of) pdarray, Strings, or Categorical) – The array to group by value, or if list, the column arrays to group by row
assume_sorted (bool) – If True, assume keys is already sorted (Default: False)
The unique values of the keys array(s), in grouped order
(list of) pdarray, Strings, or Categorical
+(list of) pdarray, Strings, or Categorical
values (pdarray, Strings) – The values to put in each group’s segment
values (pdarray, Strings) – The values to put in each group’s segment
permute (bool) – If True (default), permute broadcast values back to the ordering of the original array on which GroupBy was called. If False, the broadcast values are grouped by value.
The broadcasted values
Notes
Objects registered with the server are immune to deletion until @@ -28718,7 +28740,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -28744,7 +28766,7 @@
Notes
Objects registered with the server are immune to deletion until @@ -28772,7 +28794,7 @@
segments (pdarray, int64) – Offsets of the start of each row in the sparse matrix or grouped array. Must be sorted in ascending order.
values (pdarray, Strings) – The values to broadcast, one per row (or group)
values (pdarray, Strings) – The values to broadcast, one per row (or group)
size (int) – The total number of nonzeros in the matrix. If permutation is given, this argument is ignored and the size is inferred from the permutation array.
permutation (pdarray, int64) – The permutation to go from the original ordering of nonzeros to the ordering @@ -28829,7 +28851,7 @@
The broadcast values, one per nonzero
ValueError –
pda ((list of) pdarray, Strings, or Categorical) – Input array.
pda ((list of) pdarray, Strings, or Categorical) – Input array.
return_groups (bool, optional) – If True, also return grouping information for the array.
return_indices (bool, optional) – Only applicable if return_groups is True. If True, return unique key indices along with other groups
condition (pdarray) – Used to choose values from A or B
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
A (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is True
B (Union[numeric_scalars, str, pdarray, Strings, Categorical]) – Value(s) used when condition is False
Notes
Registered names/pdarrays in the server are immune to deletion @@ -30082,7 +30104,7 @@
Notes
Registered names/pdarrays in the server are immune to deletion until @@ -30120,7 +30142,7 @@
Notes
Registered names/pdarrays in the server are immune to deletion @@ -30215,7 +30237,7 @@
array of the requested size and dtype filled with fill_value
TypeError – Raised if the supplied dtype is not supported or if the size @@ -30333,7 +30355,7 @@
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
arrays (Sequence[Union[pdarray,Strings,Categorical]]) – The arrays to concatenate. Must all have same dtype.
ordered (bool) – If True (default), the arrays will be appended in the order given. If False, array data may be interleaved in blocks, which can greatly improve performance but @@ -30345,7 +30367,7 @@
Union[pdarray,Strings,Categorical]
+Union[pdarray,Strings,Categorical]
a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
a (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements for which to test membership in b
b (list of pdarrays, pdarray, Strings, or Categorical) – Rows are elements of the set in which to test membership
assume_unique (bool) – If true, assume rows of a and b are each unique and sorted. By default, sort and unique them explicitly.
symmetric (bool) – Return in1d(pda1, pda2), in1d(pda2, pda1) when pda1 and 2 are single items.
Return the permutation that sorts the array.
pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
+pda (pdarray or Strings or Categorical) – The array to sort (int64, uint64, or float64)
The indices such that pda[indices]
is sorted
arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
+arrays (Sequence[Union[Strings, pdarray, Categorical]]) – The columns (int64, uint64, float64, Strings, or Categorical) to sort by row
The indices that permute the rows to grouped order
@@ -30595,7 +30617,7 @@Factory method for creating a Strings object from an Arkouda server response message
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -30620,7 +30642,7 @@Factory method for creating a Strings object from an Arkouda server response where the arrays are separate components.
object representing a segmented strings array on the server
RuntimeError – Raised if there’s an error converting a server-returned str-descriptor
@@ -30721,7 +30743,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -30746,7 +30768,7 @@A new Strings object in toEncoding
RuntimeError – Raised if there is a server-side error thrown
@@ -30756,7 +30778,7 @@Returns a new Strings with all uppercase characters from the original replaced with their lowercase equivalent
RuntimeError – Raised if there is a server-side error thrown
@@ -30773,7 +30795,7 @@Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -30787,7 +30809,7 @@ Return Type
-
-upper() Strings #
+upper() Strings #
Returns a new Strings with all lowercase characters from the original replaced with
their uppercase equivalent
@@ -30796,7 +30818,7 @@ Return Type
their uppercase equivalent
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -30804,7 +30826,7 @@ Return Type
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -30818,14 +30840,14 @@ Return Type
-
-title() Strings #
+title() Strings #
Returns a new Strings from the original replaced with their titlecase equivalent
- Returns:
Strings from the original replaced with their titlecase equivalent
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -30833,7 +30855,7 @@ Return Type
Examples
>>> strings = ak.array([f'StrINgS {i}' for i in range(5)])
@@ -30863,7 +30885,7 @@ Return Type
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -30895,7 +30917,7 @@ Return Type
Examples
>>> lower = ak.array([f'strings {i}' for i in range(3)])
@@ -30927,7 +30949,7 @@ Return Type
Examples
>>> mixed = ak.array([f'sTrINgs {i}' for i in range(3)])
@@ -30959,7 +30981,7 @@ Return Type
See also
-
+
Examples
>>> not_alnum = ak.array([f'%Strings {i}' for i in range(3)])
@@ -30992,7 +31014,7 @@ Return Type
See also
-Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
+Strings.islower
, Strings.isupper
, Strings.istitle
, Strings.isalnum
Examples
>>> not_alpha = ak.array([f'%Strings {i}' for i in range(3)])
@@ -31024,7 +31046,7 @@ Return Type
See also
-
+
Examples
>>> not_digit = ak.array([f'Strings {i}' for i in range(3)])
@@ -31040,7 +31062,7 @@ Return Type
-
-strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
+strip(chars: bytes | arkouda.dtypes.str_scalars | None = '') Strings #
Returns a new Strings object with all leading and trailing occurrences of characters contained
in chars removed. The chars argument is a string specifying the set of characters to be removed.
If omitted, the chars argument defaults to removing whitespace. The chars argument is not a
@@ -31054,7 +31076,7 @@
Return Type
the chars argument removed
- Return type:
--
+
-
- Raises:
RuntimeError – Raised if there is a server-side error thrown
@@ -31209,7 +31231,7 @@ Return Type
-
-split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
+split(pattern: bytes | arkouda.dtypes.str_scalars, maxsplit: int = 0, return_segments: bool = False) Strings | Tuple #
Returns a new Strings split by the occurrences of pattern.
If maxsplit is nonzero, at most maxsplit splits occur
@@ -31241,7 +31263,7 @@ Return Type
-
-findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
+findall(pattern: bytes | arkouda.dtypes.str_scalars, return_match_origins: bool = False) Strings | Tuple #
Return a new Strings containg all non-overlapping matches of pattern
- Parameters:
@@ -31280,7 +31302,7 @@ Return Type
-
-sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
+sub(pattern: bytes | arkouda.dtypes.str_scalars, repl: bytes | arkouda.dtypes.str_scalars, count: int = 0) Strings #
Return new Strings obtained by replacing non-overlapping occurrences of pattern with the
replacement repl.
If count is nonzero, at most count substitutions occur
@@ -31297,7 +31319,7 @@ Return Type
Strings with pattern matches replaced
- Return type:
--
+
-
- Raises:
@@ -31496,7 +31518,7 @@ Return Type
-
-flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
+flatten(delimiter: str, return_segments: bool = False, regex: bool = False) Strings | Tuple #
Unpack delimiter-joined substrings into a flat array.
- Return type:
--
+
-
- Raises:
- Return type:
--
+
-
- Raises:
@@ -31666,14 +31688,14 @@ Return Type
-
-stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
+stick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '', toLeft: bool = False) Strings #
Join the strings from another array onto one end of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-other (Strings) – The strings to join onto self’s strings
+other (Strings) – The strings to join onto self’s strings
delimiter (str) – String inserted between self and other
toLeft (bool) – If true, join other strings to the left of self. By default,
other is joined to the right of self.
@@ -31683,7 +31705,7 @@ Return Type
The array of joined strings
- Return type:
--
+
-
- Raises:
@@ -31709,14 +31731,14 @@ Return Type
-
-lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
+lstick(other: Strings, delimiter: bytes | arkouda.dtypes.str_scalars = '') Strings #
Join the strings from another array onto the left of the strings
of this array, optionally inserting a delimiter.
Warning: This function is experimental and not guaranteed to work.
- Parameters:
-
@@ -31724,7 +31746,7 @@ Return Type
The array of joined strings, as other + self
- Return type:
--
+
-
- Raises:
@@ -31749,7 +31771,7 @@ Return Type
-
-get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_prefixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long prefix of each string, where possible
- Parameters:
@@ -31776,7 +31798,7 @@ Return Type
-
-get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
+get_suffixes(n: arkouda.dtypes.int_scalars, return_origins: bool = True, proper: bool = True) Strings | Tuple[Strings, arkouda.pdarrayclass.pdarray] #
Return the n-long suffix of each string, where possible
- Parameters:
@@ -31878,7 +31900,7 @@ Return Type
value, but proceed with caution.