The time-interval Reference Manual

This is the time-interval Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:07:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 time-interval

A library for representing intervals of time

Author

Cyrus Harmon <>

License

BSD

Version

0.0.1

Dependencies
  • cl-ppcre (system).
  • local-time (system).
Source

time-interval.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 time-interval/time-interval.asd

Source

time-interval.asd.

Parent Component

time-interval (system).

ASDF Systems

time-interval.


3.1.2 time-interval/package.lisp

Source

time-interval.asd.

Parent Component

time-interval (system).

Packages

time-interval.


3.1.3 time-interval/time-interval.lisp

Dependency

package.lisp (file).

Source

time-interval.asd.

Parent Component

time-interval (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 time-interval

Source

package.lisp.

Nickname

interval

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: copy-time-interval (orig)
Package

time-interval.

Source

time-interval.lisp.

Function: make-timestamp* (&key year month day hour minute second nanosecond)
Package

time-interval.

Source

time-interval.lisp.

Function: negate-time-interval (orig)
Package

time-interval.

Source

time-interval.lisp.

Function: parse-time-interval-string (string)
Package

time-interval.

Source

time-interval.lisp.

Function: time-interval (&rest args)
Package

time-interval.

Source

time-interval.lisp.

Function: timestamp-decoded-difference (tend tstart)

Computes the difference between the individual components of local-time:timestamp t1 and t2. Returns 8 values: dyear dmonth dday dhh dmm dss dns dday-of-week where dyear is the difference in years, etc...

Package

time-interval.

Source

time-interval.lisp.


5.1.2 Generic functions

Generic Function: t+ (time-or-interval-1 time-or-interval-2)
Package

time-interval.

Source

time-interval.lisp.

Methods
Method: t+ ((t1 time-interval) (t2 time-interval))
Method: t+ ((t1 time-interval) (t2 timestamp))
Method: t+ ((t1 timestamp) (t2 time-interval))
Generic Function: t- (time-or-interval-1 time-or-interval-2)
Package

time-interval.

Source

time-interval.lisp.

Methods
Method: t- ((t1 timestamp) (t2 timestamp))
Method: t- ((t1 time-interval) (t2 time-interval))
Method: t- ((t1 timestamp) (t2 time-interval))

5.1.3 Standalone methods

Method: print-object ((object time-interval) stream)
Source

time-interval.lisp.


5.1.4 Classes

Class: time-interval
Package

time-interval.

Source

time-interval.lisp.

Direct methods
Direct slots
Slot: years
Initform

0

Initargs

:years

Readers

interval-years.

Writers

(setf interval-years).

Slot: months
Initform

0

Initargs

:months

Readers

interval-months.

Writers

(setf interval-months).

Slot: weeks
Initform

0

Initargs

:weeks

Readers

interval-weeks.

Writers

(setf interval-weeks).

Slot: days
Initform

0

Initargs

:days

Readers

interval-days.

Writers

(setf interval-days).

Slot: hours
Initform

0

Initargs

:hours

Readers

interval-hours.

Writers

(setf interval-hours).

Slot: minutes
Initform

0

Initargs

:minutes

Readers

interval-minutes.

Writers

(setf interval-minutes).

Slot: seconds
Initform

0

Initargs

:seconds

Readers

interval-seconds.

Writers

(setf interval-seconds).

Slot: nanoseconds
Initform

0

Initargs

:nanoseconds

Readers

interval-nanoseconds.

Writers

(setf interval-nanoseconds).


5.2 Internals


5.2.1 Special variables

Special Variable: *unit-hash*
Package

time-interval.

Source

time-interval.lisp.


5.2.2 Macros

Macro: or-zero (value)
Package

time-interval.

Source

time-interval.lisp.


5.2.3 Ordinary functions

Function: timestamp-add-interval (time interval)
Package

time-interval.

Source

time-interval.lisp.


5.2.4 Generic functions

Generic Reader: interval-days (object)
Package

time-interval.

Methods
Reader Method: interval-days ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

days.

Generic Writer: (setf interval-days) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-days) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

days.

Generic Reader: interval-hours (object)
Package

time-interval.

Methods
Reader Method: interval-hours ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

hours.

Generic Writer: (setf interval-hours) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-hours) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

hours.

Generic Reader: interval-minutes (object)
Package

time-interval.

Methods
Reader Method: interval-minutes ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

minutes.

Generic Writer: (setf interval-minutes) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-minutes) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

minutes.

Generic Reader: interval-months (object)
Package

time-interval.

Methods
Reader Method: interval-months ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

months.

Generic Writer: (setf interval-months) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-months) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

months.

Generic Reader: interval-nanoseconds (object)
Package

time-interval.

Methods
Reader Method: interval-nanoseconds ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

nanoseconds.

Generic Writer: (setf interval-nanoseconds) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-nanoseconds) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

nanoseconds.

Generic Reader: interval-seconds (object)
Package

time-interval.

Methods
Reader Method: interval-seconds ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

seconds.

Generic Writer: (setf interval-seconds) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-seconds) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

seconds.

Generic Reader: interval-weeks (object)
Package

time-interval.

Methods
Reader Method: interval-weeks ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

weeks.

Generic Writer: (setf interval-weeks) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-weeks) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

weeks.

Generic Reader: interval-years (object)
Package

time-interval.

Methods
Reader Method: interval-years ((time-interval time-interval))

automatically generated reader method

Source

time-interval.lisp.

Target Slot

years.

Generic Writer: (setf interval-years) (object)
Package

time-interval.

Methods
Writer Method: (setf interval-years) ((time-interval time-interval))

automatically generated writer method

Source

time-interval.lisp.

Target Slot

years.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   I   M   N   O   P   T  
Index Entry  Section

(
(setf interval-days): Private generic functions
(setf interval-days): Private generic functions
(setf interval-hours): Private generic functions
(setf interval-hours): Private generic functions
(setf interval-minutes): Private generic functions
(setf interval-minutes): Private generic functions
(setf interval-months): Private generic functions
(setf interval-months): Private generic functions
(setf interval-nanoseconds): Private generic functions
(setf interval-nanoseconds): Private generic functions
(setf interval-seconds): Private generic functions
(setf interval-seconds): Private generic functions
(setf interval-weeks): Private generic functions
(setf interval-weeks): Private generic functions
(setf interval-years): Private generic functions
(setf interval-years): Private generic functions

C
copy-time-interval: Public ordinary functions

F
Function, copy-time-interval: Public ordinary functions
Function, make-timestamp*: Public ordinary functions
Function, negate-time-interval: Public ordinary functions
Function, parse-time-interval-string: Public ordinary functions
Function, time-interval: Public ordinary functions
Function, timestamp-add-interval: Private ordinary functions
Function, timestamp-decoded-difference: Public ordinary functions

G
Generic Function, (setf interval-days): Private generic functions
Generic Function, (setf interval-hours): Private generic functions
Generic Function, (setf interval-minutes): Private generic functions
Generic Function, (setf interval-months): Private generic functions
Generic Function, (setf interval-nanoseconds): Private generic functions
Generic Function, (setf interval-seconds): Private generic functions
Generic Function, (setf interval-weeks): Private generic functions
Generic Function, (setf interval-years): Private generic functions
Generic Function, interval-days: Private generic functions
Generic Function, interval-hours: Private generic functions
Generic Function, interval-minutes: Private generic functions
Generic Function, interval-months: Private generic functions
Generic Function, interval-nanoseconds: Private generic functions
Generic Function, interval-seconds: Private generic functions
Generic Function, interval-weeks: Private generic functions
Generic Function, interval-years: Private generic functions
Generic Function, t+: Public generic functions
Generic Function, t-: Public generic functions

I
interval-days: Private generic functions
interval-days: Private generic functions
interval-hours: Private generic functions
interval-hours: Private generic functions
interval-minutes: Private generic functions
interval-minutes: Private generic functions
interval-months: Private generic functions
interval-months: Private generic functions
interval-nanoseconds: Private generic functions
interval-nanoseconds: Private generic functions
interval-seconds: Private generic functions
interval-seconds: Private generic functions
interval-weeks: Private generic functions
interval-weeks: Private generic functions
interval-years: Private generic functions
interval-years: Private generic functions

M
Macro, or-zero: Private macros
make-timestamp*: Public ordinary functions
Method, (setf interval-days): Private generic functions
Method, (setf interval-hours): Private generic functions
Method, (setf interval-minutes): Private generic functions
Method, (setf interval-months): Private generic functions
Method, (setf interval-nanoseconds): Private generic functions
Method, (setf interval-seconds): Private generic functions
Method, (setf interval-weeks): Private generic functions
Method, (setf interval-years): Private generic functions
Method, interval-days: Private generic functions
Method, interval-hours: Private generic functions
Method, interval-minutes: Private generic functions
Method, interval-months: Private generic functions
Method, interval-nanoseconds: Private generic functions
Method, interval-seconds: Private generic functions
Method, interval-weeks: Private generic functions
Method, interval-years: Private generic functions
Method, print-object: Public standalone methods
Method, t+: Public generic functions
Method, t+: Public generic functions
Method, t+: Public generic functions
Method, t-: Public generic functions
Method, t-: Public generic functions
Method, t-: Public generic functions

N
negate-time-interval: Public ordinary functions

O
or-zero: Private macros

P
parse-time-interval-string: Public ordinary functions
print-object: Public standalone methods

T
t+: Public generic functions
t+: Public generic functions
t+: Public generic functions
t+: Public generic functions
t-: Public generic functions
t-: Public generic functions
t-: Public generic functions
t-: Public generic functions
time-interval: Public ordinary functions
timestamp-add-interval: Private ordinary functions
timestamp-decoded-difference: Public ordinary functions