The easter-gauss Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The easter-gauss Reference Manual

This is the easter-gauss Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:38:48 2022 GMT+0.

Table of Contents


1 Introduction

This package exports a  single method, ~easter-date:easter-date~. The
method takes a single argument and is specialized on integer or an istance of a
[[https://local-time.common-lisp.dev/][timestamp class from the
local-date library]]. When called, the methods performs the algorithm invented by
[[https://en.wikipedia.org/wiki/Date_of_Easter#Gauss's_Easter_algorithm][Gauss]]
to calculate the Easter date and returns two values: the day (starting
from ~1~) and the month (~3~ or ~4~) of the Easter.

Examples given below:

#+BEGIN_SRC lisp

  (easter-date:easter-date (local-time:now)) ; the date for the Easter in the current year

  (easter-date:easter-date 2022) ; the date for the Easter for the year 2022 (values 17 4)

#+END_SRC

* LICENSE

Copyright © 2022 cage

Permission is hereby granted, free  of charge, to any person obtaining
a  copy  of this  software  and  associated documentation  files  (the
“Software”), to  deal in  the Software without  restriction, including
without limitation  the rights to  use, copy, modify,  merge, publish,
distribute, sublicense,  and/or sell  copies of  the Software,  and to
permit persons to whom the Software  is furnished to do so, subject to
the following conditions:

The  above  copyright  notice  and this  permission  notice  shall  be
included in all copies or substantial portions of the Software.

THE  SOFTWARE IS  PROVIDED  “AS  IS”, WITHOUT  WARRANTY  OF ANY  KIND,
EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING  FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 easter-gauss

Calculate the Ester date from year using the method developed from Gauss.

Maintainer

cage

Author

cage

Bug Tracker

https://notabug.org/cage/easter-gauss/issues

License

MIT

Version

0.0.1

Dependency

local-time (system).

Source

easter-gauss.asd.

Child Components

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 easter-gauss/easter-gauss.asd

Source

easter-gauss.asd.

Parent Component

easter-gauss (system).

ASDF Systems

easter-gauss.


3.1.2 easter-gauss/package.lisp

Source

easter-gauss.asd.

Parent Component

easter-gauss (system).

Packages

easter-date.


3.1.3 easter-gauss/easter.lisp

Dependency

package.lisp (file).

Source

easter-gauss.asd.

Parent Component

easter-gauss (system).

Public Interface

easter-date (generic function).

Internals

easter-date-approx (function).


4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 easter-date

Source

package.lisp.

Use List

common-lisp.

Public Interface

easter-date (generic function).

Internals

easter-date-approx (function).


5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Generic functions

Generic Function: easter-date (object)
Package

easter-date.

Source

easter.lisp.

Methods
Method: easter-date ((object timestamp))

Calculate the Easter date of the timestamp passed as argument. Returns two values: the day an the month of the Easter

Method: easter-date ((object integer))

Calculate the Easter date of the year passed as argument. Returns two values: the day an the month of the Easter


5.2 Internals


Previous: , Up: Internals   [Contents][Index]

5.2.1 Ordinary functions

Function: easter-date-approx (year)
Package

easter-date.

Source

easter.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables