arkouda.timeclass

Module Contents

Classes

Datetime	Represents a date and/or time.
Timedelta	Represents a duration, the difference between two dates or times.

Functions

date_range([start, end, periods, freq, tz, normalize, ...])	Creates a fixed frequency Datetime range. Alias for
timedelta_range([start, end, periods, freq, name, closed])	Return a fixed frequency TimedeltaIndex, with day as the default

class arkouda.timeclass.Datetime(pda, unit: str = _BASE_UNIT)

Bases: _AbstractBaseTime

Represents a date and/or time.

Datetime is the Arkouda analog to pandas DatetimeIndex and other timeseries data types.

Parameters:

• pda (int64 pdarray, pd.DatetimeIndex, pd.Series, or np.datetime64 array)

• unit (str, default 'ns') –

  For int64 pdarray, denotes the unit of the input. Ignored for pandas and numpy arrays, which carry their own unit. Not case-sensitive; prefixes of full names (like ‘sec’) are accepted.

  Possible values:

  • ’weeks’ or ‘w’

  • ’days’ or ‘d’

  • ’hours’ or ‘h’

  • ’minutes’, ‘m’, or ‘t’

  • ’seconds’ or ‘s’

  • ’milliseconds’, ‘ms’, or ‘l’

  • ’microseconds’, ‘us’, or ‘u’

  • ’nanoseconds’, ‘ns’, or ‘n’

  Unlike in pandas, units cannot be combined or mixed with integers

Notes

The .values attribute is always in nanoseconds with int64 dtype.

property date

property day

property day_of_week

property day_of_year

property dayofweek

property dayofyear

property hour

property is_leap_year

property microsecond

property millisecond

property minute

property month

property nanosecond

property second

property week

property weekday

property weekofyear

property year

special_objType = 'Datetime'

supported_opeq

supported_with_datetime

supported_with_pdarray

supported_with_r_datetime

supported_with_r_pdarray

supported_with_r_timedelta

supported_with_timedelta

is_registered() → numpy.bool_

Return True iff the object is contained in the registry or is a component of a registered object.

Returns:

Indicates if the object is contained in the registry

Return type:

numpy.bool

Raises:

RegistrationError – Raised if there’s a server-side error or a mis-match of registered components

See also

register, attach, unregister

Notes

Objects registered with the server are immune to deletion until they are unregistered.

isocalendar()

register(user_defined_name)

Register this Datetime object and underlying components with the Arkouda server

Parameters:

user_defined_name (str) – user defined name the Datetime is to be registered under, this will be the root name for underlying components

Returns:

The same Datetime which is now registered with the arkouda server and has an updated name. This is an in-place modification, the original is returned to support a fluid programming style. Please note you cannot register two different Datetimes with the same name.

Return type:

Datetime

Raises:

• TypeError – Raised if user_defined_name is not a str

• RegistrationError – If the server was unable to register the Datetimes with the user_defined_name

See also

unregister, attach, is_registered

Notes

Objects registered with the server are immune to deletion until they are unregistered.

sum()

Return the sum of all elements in the array.

to_pandas()

Convert array to a pandas DatetimeIndex. Note: if the array size exceeds client.maxTransferBytes, a RuntimeError is raised.

See also

to_ndarray

unregister()

Unregister this Datetime object in the arkouda server which was previously registered using register() and/or attached to using attach()

Raises:

RegistrationError – If the object is already unregistered or if there is a server error when attempting to unregister

See also

register, attach, is_registered

Notes

Objects registered with the server are immune to deletion until they are unregistered.

class arkouda.timeclass.Timedelta(pda, unit: str = _BASE_UNIT)

Bases: _AbstractBaseTime

Represents a duration, the difference between two dates or times.

Timedelta is the Arkouda equivalent of pandas.TimedeltaIndex.

Parameters:

• pda (int64 pdarray, pd.TimedeltaIndex, pd.Series, or np.timedelta64 array)

• unit (str, default 'ns') –

  For int64 pdarray, denotes the unit of the input. Ignored for pandas and numpy arrays, which carry their own unit. Not case-sensitive; prefixes of full names (like ‘sec’) are accepted.

  Possible values:

  • ’weeks’ or ‘w’

  • ’days’ or ‘d’

  • ’hours’ or ‘h’

  • ’minutes’, ‘m’, or ‘t’

  • ’seconds’ or ‘s’

  • ’milliseconds’, ‘ms’, or ‘l’

  • ’microseconds’, ‘us’, or ‘u’

  • ’nanoseconds’, ‘ns’, or ‘n’

  Unlike in pandas, units cannot be combined or mixed with integers

Notes

The .values attribute is always in nanoseconds with int64 dtype.

property components

property days

property microseconds

property nanoseconds

property seconds

special_objType = 'Timedelta'

supported_opeq

supported_with_datetime

supported_with_pdarray

supported_with_r_datetime

supported_with_r_pdarray

supported_with_r_timedelta

supported_with_timedelta

abs()

Absolute value of time interval.

is_registered() → numpy.bool_

Return True iff the object is contained in the registry or is a component of a registered object.

Returns:

Indicates if the object is contained in the registry

Return type:

numpy.bool

Raises:

RegistrationError – Raised if there’s a server-side error or a mis-match of registered components

See also

register, attach, unregister

Notes

Objects registered with the server are immune to deletion until they are unregistered.

register(user_defined_name)

Register this Timedelta object and underlying components with the Arkouda server

Parameters:

user_defined_name (str) – user defined name the timedelta is to be registered under, this will be the root name for underlying components

Returns:

The same Timedelta which is now registered with the arkouda server and has an updated name. This is an in-place modification, the original is returned to support a fluid programming style. Please note you cannot register two different Timedeltas with the same name.

Return type:

Timedelta

Raises:

• TypeError – Raised if user_defined_name is not a str

• RegistrationError – If the server was unable to register the timedelta with the user_defined_name

See also

unregister, attach, is_registered

Notes

Objects registered with the server are immune to deletion until they are unregistered.

std(ddof: arkouda.dtypes.int_scalars = 0)

Returns the standard deviation as a pd.Timedelta object

sum()

Return the sum of all elements in the array.

to_pandas()

Convert array to a pandas TimedeltaIndex. Note: if the array size exceeds client.maxTransferBytes, a RuntimeError is raised.

See also

to_ndarray

total_seconds()

unregister()

Unregister this timedelta object in the arkouda server which was previously registered using register() and/or attached to using attach()

Raises:

RegistrationError – If the object is already unregistered or if there is a server error when attempting to unregister

See also

register, attach, is_registered

Notes

Objects registered with the server are immune to deletion until they are unregistered.

arkouda.timeclass.date_range(start=None, end=None, periods=None, freq=None, tz=None, normalize=False, name=None, closed=None, inclusive='both', **kwargs)

Creates a fixed frequency Datetime range. Alias for ak.Datetime(pd.date_range(args)). Subject to size limit imposed by client.maxTransferBytes.

Parameters:

• start (str or datetime-like, optional) – Left bound for generating dates.

• end (str or datetime-like, optional) – Right bound for generating dates.

• periods (int, optional) – Number of periods to generate.

• freq (str or DateOffset, default 'D') – Frequency strings can have multiples, e.g. ‘5H’. See timeseries.offset_aliases for a list of frequency aliases.

• tz (str or tzinfo, optional) – Time zone name for returning localized DatetimeIndex, for example ‘Asia/Hong_Kong’. By default, the resulting DatetimeIndex is timezone-naive.

• normalize (bool, default False) – Normalize start/end dates to midnight before generating date range.

• name (str, default None) – Name of the resulting DatetimeIndex.

• closed ({None, 'left', 'right'}, optional) – Make the interval closed with respect to the given frequency to the ‘left’, ‘right’, or both sides (None, the default). Deprecated

• inclusive ({"both", "neither", "left", "right"}, default "both") – Include boundaries. Whether to set each bound as closed or open.

• **kwargs – For compatibility. Has no effect on the result.

Returns:

rng

Return type:

DatetimeIndex

Notes

Of the four parameters start, end, periods, and freq, exactly three must be specified. If freq is omitted, the resulting DatetimeIndex will have periods linearly spaced elements between start and end (closed on both sides).

To learn more about the frequency strings, please see this link.

arkouda.timeclass.timedelta_range(start=None, end=None, periods=None, freq=None, name=None, closed=None, **kwargs)

Return a fixed frequency TimedeltaIndex, with day as the default frequency. Alias for ak.Timedelta(pd.timedelta_range(args)). Subject to size limit imposed by client.maxTransferBytes.

Parameters:

• start (str or timedelta-like, default None) – Left bound for generating timedeltas.

• end (str or timedelta-like, default None) – Right bound for generating timedeltas.

• periods (int, default None) – Number of periods to generate.

• freq (str or DateOffset, default 'D') – Frequency strings can have multiples, e.g. ‘5H’.

• name (str, default None) – Name of the resulting TimedeltaIndex.

• closed (str, default None) – Make the interval closed with respect to the given frequency to the ‘left’, ‘right’, or both sides (None).

Returns:

rng

Return type:

TimedeltaIndex

Notes

Of the four parameters start, end, periods, and freq, exactly three must be specified. If freq is omitted, the resulting TimedeltaIndex will have periods linearly spaced elements between start and end (closed on both sides).

To learn more about the frequency strings, please see this link.