Usage Guide

• Startup
  • Launch arkouda server
  • Connect a Python 3 client
    • connect()
• The pdarray class
  • pdarray
    • pdarray.name
    • pdarray.dtype
    • pdarray.size
    • pdarray.ndim
    • pdarray.shape
    • pdarray.itemsize
  • Data Type
  • Rank
  • Name
  • Operators
  • Iteration
    • to_ndarray()
  • Type Casting
    • cast()
  • Reshape
• Creating Arrays
  • Constant
    • zeros()
    • ones()
    • zeros_like()
    • ones_like()
  • Regular
    • arange()
    • linspace()
  • Random
    • randint()
  • Concatenation
    • concatenate()
• Arithmetic and Numeric Operations
  • Vector and Scalar Arithmetic
  • Element-wise Functions
    • abs()
    • log()
    • exp()
    • sin()
    • cos()
  • Scans
    • cumsum()
    • cumprod()
  • Reductions
    • any()
    • all()
    • is_sorted()
    • sum()
    • prod()
    • min()
    • max()
    • argmin()
    • argmax()
    • mean()
    • var()
    • std()
    • mink()
    • maxk()
    • argmink()
    • argmaxk()
  • Where
    • where()
• Indexing and Assignment
  • Integer
  • Slice
  • Gather/Scatter (pdarray)
    • Integer pdarray index
    • Logical indexing
• Summarizing Data
  • Descriptive Statistics
    • pdarray.any()
    • pdarray.all()
    • pdarray.is_sorted()
    • pdarray.sum()
    • pdarray.prod()
    • pdarray.min()
    • pdarray.max()
    • pdarray.argmin()
    • pdarray.argmax()
    • pdarray.mean()
    • pdarray.var()
    • pdarray.std()
    • pdarray.mink()
    • pdarray.maxk()
    • pdarray.argmink()
    • pdarray.argmaxk()
  • Histogram
    • histogram()
  • Value Counts
    • value_counts()
• Sorting
  • argsort()
  • coargsort()
• Array Set Operations
  • unique()
  • in1d()
  • union1d()
  • intersect1d()
  • setdiff1d()
  • setxor1d()
• GroupBy
  • GroupBy
    • GroupBy.nkeys
    • GroupBy.size
    • GroupBy.permutation
    • GroupBy.unique_keys
    • GroupBy.ngroups
    • GroupBy.segments
    • GroupBy.logger
    • GroupBy.dropna
    • GroupBy.AND()
    • GroupBy.OR()
    • GroupBy.XOR()
    • GroupBy.aggregate()
    • GroupBy.all()
    • GroupBy.any()
    • GroupBy.argmax()
    • GroupBy.argmin()
    • GroupBy.attach()
    • GroupBy.broadcast()
    • GroupBy.build_from_components()
    • GroupBy.count()
    • GroupBy.first()
    • GroupBy.head()
    • GroupBy.is_registered()
    • GroupBy.max()
    • GroupBy.mean()
    • GroupBy.median()
    • GroupBy.min()
    • GroupBy.mode()
    • GroupBy.most_common()
    • GroupBy.nunique()
    • GroupBy.prod()
    • GroupBy.register()
    • GroupBy.sample()
    • GroupBy.size()
    • GroupBy.std()
    • GroupBy.sum()
    • GroupBy.tail()
    • GroupBy.to_hdf()
    • GroupBy.unique()
    • GroupBy.unregister()
    • GroupBy.unregister_groupby_by_name()
    • GroupBy.var()
• Strings in Arkouda
  • Performance
  • I/O
  • Iteration
    • to_ndarray()
  • Operations
  • String-Specific Methods
    • Substring search
      • Strings.contains()
      • Strings.startswith()
      • Strings.endswith()
    • Splitting and joining
      • Strings.peel()
      • Strings.rpeel()
      • Strings.stick()
      • Strings.lstick()
    • Flattening
      • Strings.flatten()
    • Regular Expressions
      • Strings.search()
      • Strings.match()
      • Strings.fullmatch()
      • Strings.split()
      • Strings.findall()
      • Strings.sub()
      • Strings.subn()
      • Strings.find_locations()
      • Match Object
        • Match.matched()
        • Match.start()
        • Match.end()
        • Match.match_type()
        • Match.find_matches()
        • Match.group()
• Categoricals
  • Construction
    • Categorical
      • Categorical.categories
      • Categorical.codes
      • Categorical.permutation
      • Categorical.segments
      • Categorical.size
      • Categorical.nlevels
      • Categorical.ndim
      • Categorical.shape
    • Categorical.from_codes()
  • Operations
    • Categorical.contains()
    • Categorical.startswith()
    • Categorical.endswith()
  • Iteration
    • to_ndarray()
• Random in Arkouda
  • Generator
  • Creation
  • Features
    • choice
      • choice()
    • exponential
      • exponential()
    • integers
      • integers()
    • logistic
      • logistic()
    • lognormal
      • lognormal()
    • normal
      • normal()
    • permutation
      • permutation()
    • poisson
      • poisson()
    • shuffle
      • shuffle()
    • random
      • random()
    • standard_exponential
      • standard_exponential()
    • standard_normal
      • standard_normal()
    • uniform
      • uniform()
• SegArrays in Arkouda
  • Performance
  • Iteration
    • to_ndarray()
  • Operation
  • SegArray Specific Methods
    • Prefix & Suffix
      • get_prefixes()
      • get_suffixes()
    • NGrams
      • get_ngrams()
    • Sub-array of Size
      • get_length_n()
    • Access/Set Specific Elements in Sub-Array
      • get_jth()
      • set_jth()
    • Append & Prepend
      • append()
      • append_single()
      • prepend_single()
    • Deduplication
      • remove_repeats()
  • SegArray SetOps
    • Union
      • union()
    • Intersect
      • intersect()
    • Set Difference
      • setdiff()
    • Symmetric Difference
      • setxor()