Skip to content

Latest commit

 

History

History
885 lines (665 loc) · 12.2 KB

api.rst

File metadata and controls

885 lines (665 loc) · 12.2 KB
Raw

API Reference

larray

Axis

Axis

Exploring

Axis.name Name of the axis. None in the case of an anonymous axis.
Axis.labels Labels of the axis.
--------------------------- --------------------------------------------------------------
Axis.labels_summary Short representation of the labels.
--------------------------- --------------------------------------------------------------
Axis.dtype Data type for the axis labels.

Copying

Axis.copy

Searching

Axis.index Axis.containing Axis.startingwith Axis.endingwith Axis.matching Axis.min Axis.max

Modifying/Selecting

Axis.__getitem__ Axis.i Axis.by Axis.rename Axis.extend Axis.insert Axis.replace Axis.apply Axis.union Axis.intersection Axis.difference Axis.align Axis.split Axis.ignore_labels Axis.astype

Testing

Axis.iscompatible Axis.equals

Save

Axis.to_hdf

Group

IGroup

IGroup

IGroup.named IGroup.with_axis IGroup.by IGroup.equals IGroup.translate IGroup.union IGroup.intersection IGroup.difference IGroup.containing IGroup.startingwith IGroup.endingwith IGroup.matching IGroup.to_hdf

LGroup

LGroup

LGroup.named LGroup.with_axis LGroup.by LGroup.equals LGroup.translate LGroup.union LGroup.intersection LGroup.difference LGroup.containing LGroup.startingwith LGroup.endingwith LGroup.matching LGroup.to_hdf

LSet

LSet

AxisCollection

AxisCollection

AxisCollection.names AxisCollection.display_names AxisCollection.labels AxisCollection.shape AxisCollection.size AxisCollection.info AxisCollection.copy

Searching

AxisCollection.keys AxisCollection.index AxisCollection.axis_id AxisCollection.ids AxisCollection.iter_labels

Modifying/Selecting

AxisCollection.get AxisCollection.get_by_pos AxisCollection.get_all AxisCollection.pop AxisCollection.append AxisCollection.extend AxisCollection.insert AxisCollection.rename AxisCollection.replace AxisCollection.set_labels AxisCollection.without AxisCollection.combine_axes AxisCollection.split_axes AxisCollection.align

Testing

AxisCollection.isaxis AxisCollection.check_compatible

Array

  • la_overview
  • la_creation_func
  • la_copying
  • la_inspecting
  • la_selecting
  • la_axes_labels
  • la_agg
  • la_sorting
  • la_reshaping
  • la_testing
  • la_iter
  • la_op
  • la_misc
  • la_to_pandas
  • la_plotting

Overview

Array

Array Creation Functions

sequence ndtest zeros zeros_like ones ones_like empty empty_like full full_like

Copying

Array.copy Array.astype

Inspecting

Array.data Data of the array (Numpy ndarray)
Array.axes Axes of the array (AxisCollection)
------------------ --------------------------------------------------------------
Array.title Title of the array (str)

Array.info Array.shape Array.ndim Array.dtype Array.size Array.nbytes Array.memory_used

Modifying/Selecting

Array.i Array.points Array.ipoints Array.iflat Array.set Array.drop Array.ignore_labels Array.filter Array.apply Array.apply_map

Changing Axes or Labels

Array.set_axes Array.rename Array.set_labels Array.combine_axes Array.split_axes Array.reverse

Aggregation Functions

Array.sum Array.sum_by Array.prod Array.prod_by Array.cumsum Array.cumprod Array.mean Array.mean_by Array.median Array.median_by Array.var Array.var_by Array.std Array.std_by Array.percentile Array.percentile_by Array.ptp Array.with_total Array.percent Array.ratio Array.rationot0 Array.growth_rate Array.describe Array.describe_by Array.value_counts

Sorting

Array.sort_labels Array.sort_values Array.labelsofsorted Array.indicesofsorted

Reshaping/Extending/Reordering

Array.reshape Array.reshape_like Array.compact Array.reindex Array.transpose Array.expand Array.prepend Array.append Array.extend Array.insert Array.broadcast_with Array.align

Testing/Searching

Array.equals Array.allclose Array.eq Array.isin Array.nonzero Array.all Array.all_by Array.any Array.any_by Array.min Array.min_by Array.max Array.max_by Array.labelofmin Array.indexofmin Array.labelofmax Array.indexofmax

Iterating

Array.keys Array.values Array.items

Operators

:py@ <Array.__matmul__> Matrix multiplication

Miscellaneous

Array.divnot0 Array.clip Array.shift Array.roll Array.diff Array.unique Array.to_clipboard

Converting to Pandas objects

Array.to_series Array.to_frame

Plotting

Array.plot

Utility Functions

  • ufuncs_misc
  • ufuncs_rounding
  • ufuncs_exp_log
  • ufuncs_trigo
  • ufuncs_hyper
  • ufuncs_complex
  • ufuncs_floating

Miscellaneous

where maximum minimum inverse interp convolve absolute fabs isscalar isnan isinf nan_to_num sqrt i0 sinc

Rounding

round floor ceil trunc rint fix

Exponents And Logarithms

exp expm1 exp2 log log10 log2 log1p logaddexp logaddexp2

Trigonometric functions

sin cos tan arcsin arccos arctan hypot arctan2 degrees radians unwrap

Hyperbolic functions

sinh cosh tanh arcsinh arccosh arctanh

Complex Numbers

angle real imag conj

Floating Point Routines

signbit copysign frexp ldexp

Metadata

Metadata

Input/Output

Read

read_csv read_tsv read_excel read_hdf read_eurostat read_sas read_stata

Write

Array.to_csv Array.to_excel Array.to_hdf Array.to_stata Array.dump

Excel

open_excel

Workbook Workbook.sheet_names Workbook.save Workbook.close Workbook.app

ExcelReport

ExcelReport ExcelReport.template_dir ExcelReport.template ExcelReport.set_item_default_size ExcelReport.graphs_per_row ExcelReport.new_sheet ExcelReport.sheet_names ExcelReport.to_excel

ReportSheet

ReportSheet ReportSheet.template_dir ReportSheet.template ReportSheet.set_item_default_size ReportSheet.graphs_per_row ReportSheet.add_title ReportSheet.add_graph ReportSheet.add_graphs ReportSheet.newline

Miscellaneous

asarray from_frame from_series get_example_filepath set_options get_options labels_array union stack identity diag eye ipfp wrap_elementwise_array_func zip_array_values zip_array_items

Session

Session arrays local_arrays global_arrays load_example_data

Exploring

Session.names Session.keys Session.values Session.items Session.summary

Copying

Session.copy

Testing

Session.element_equals Session.equals

Selecting

Session.get

Modifying

Session.add Session.update Session.apply Session.transpose

Filtering/Cleaning

Session.filter Session.compact

Load/Save

Session.load Session.save Session.to_csv Session.to_excel Session.to_hdf Session.to_pickle

CheckedArray

CheckedArray

CheckedSession

CheckedSession

CheckedParameters

CheckedParameters

Editor

view edit debug compare run_editor_on_exception

Random

random.randint random.normal random.uniform random.permutation random.choice

Constants

larray.core.constants

nan inf pi e euler_gamma