The cl-libfarmhash Reference Manual

Table of Contents

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

The cl-libfarmhash Reference Manual

This is the cl-libfarmhash Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:13:05 2018 GMT+0.


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

1 Introduction

cl-libfarmhash - Common Lisp Binding for Google's Farmhash.

Usage

note: all results shown below are from a 64bit Mac OS platform.

farmhash

FARM> (farmhash "test")
2929758365

farmhash32

FARM> (farmhash32 "test")
168770635

farmhash32-with-seed

FARM> (farmhash32-with-seed "test" 12345)
687740529

farmhash64

FARM> (farmhash64 "test")
656818571139125405

farmhash64-with-seed

FARM> (farmhash64-with-seed "test" 12345)
1329645378812687902

farmhash64-with-seeds

FARM> (farmhash64-with-seeds "test" 12345 54321)
2807312541950536949

farmhash128

FARM> (farmhash128 "test")
278051559519782271719215074689603618262

farmhash128-with-seed

FARM> (farmhash128-with-seed "test" 1234554321)
8373479877626909324346027983011427843

farmhash-fingerprint32

FARM> (farmhash-fingerprint32 "test")
1633095781

farmhash-fingerprint64

FARM> (farmhash-fingerprint64 "test")
8581389452482819506

farmhash-fingerprint128

FARM> (farmhash-fingerprint128 "test")
334882099032867325754781607143811124132

Installation

Just (ql:quickload :cl-libfarmhash). All exported functions has been simply tested on SBCL, CCL, Allegro CL and LispWorks.

Author

Copyright

Copyright (c) 2016 David Gu (macdavid313@gmail.com)


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

2 Systems

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


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

2.1 cl-libfarmhash

Author

David Gu

License

MIT

Description

Common Lisp Binding for Google’s Farmhash.

Long Description

# cl-libfarmhash - Common Lisp Binding for Google’s [Farmhash](https://github.com/google/farmhash).

<a href="http://quickdocs.org/cl-libfarmhash"><img src="http://quickdocs.org/badge/cl-libfarmhash.svg" /></a>

## Usage

**note:** _all results shown below are from a 64bit Mac OS platform._

### farmhash

“‘common-lisp
FARM> (farmhash "test")
2929758365
“‘

### farmhash32

“‘common-lisp
FARM> (farmhash32 "test")
168770635
“‘

### farmhash32-with-seed

“‘common-lisp
FARM> (farmhash32-with-seed "test" 12345)
687740529
“‘

### farmhash64

“‘common-lisp
FARM> (farmhash64 "test")
656818571139125405
“‘

### farmhash64-with-seed

“‘common-lisp
FARM> (farmhash64-with-seed "test" 12345)
1329645378812687902
“‘

### farmhash64-with-seeds

“‘common-lisp
FARM> (farmhash64-with-seeds "test" 12345 54321)
2807312541950536949
“‘

### farmhash128

“‘common-lisp
FARM> (farmhash128 "test")
278051559519782271719215074689603618262
“‘

### farmhash128-with-seed

“‘common-lisp
FARM> (farmhash128-with-seed "test" 1234554321)
8373479877626909324346027983011427843
“‘

### farmhash-fingerprint32

“‘common-lisp
FARM> (farmhash-fingerprint32 "test")
1633095781
“‘

### farmhash-fingerprint64

“‘common-lisp
FARM> (farmhash-fingerprint64 "test")
8581389452482819506
“‘

### farmhash-fingerprint128

“‘common-lisp
FARM> (farmhash-fingerprint128 "test")
334882099032867325754781607143811124132
“‘

## Installation

Just ‘(ql:quickload :cl-libfarmhash)‘. All exported functions has been simply tested on ‘SBCL‘, ‘CCL‘, ‘Allegro CL‘ and ‘LispWorks‘.

## Author

* David Gu (macdavid313@gmail.com)

## Copyright

Copyright (c) 2016 David Gu (macdavid313@gmail.com)

Version

0.1

Dependencies
Source

cl-libfarmhash.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 cl-libfarmhash/src

Parent

cl-libfarmhash (system)

Location

src/

Component

cl-libfarmhash.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 cl-libfarmhash.asd

Location

cl-libfarmhash.asd

Systems

cl-libfarmhash (system)

Packages

cl-libfarmhash-asd


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

4.1.2 cl-libfarmhash/src/cl-libfarmhash.lisp

Parent

src (module)

Location

src/cl-libfarmhash.lisp

Packages

cl-libfarmhash

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-libfarmhash-asd

Source

cl-libfarmhash.asd

Use List

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

5.2 cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Nicknames
Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: farmhash STRING

Hash function for a byte array.
May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash-fingerprint128 STRING

Fingerprint function for a byte array.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash-fingerprint32 STRING

Fingerprint function for a byte array. Most useful in 32-bit binaries.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash-fingerprint64 STRING

Fingerprint function for a byte array.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash128 STRING

Hash function for a byte array.
May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash128-with-seed STRING SEED

Hash function for a byte array. For convenience, a 128-bit seed is also hashed into the result. May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash32 STRING

Hash function for a byte array. Most useful in 32-bit binaries.
May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash32-with-seed STRING SEED

Hash function for a byte array. For convenience, a 32-bit seed is also hashed into the result. May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash64 STRING

Hash 128 input bits down to 64 bits of output.
Hash function for a byte array.
May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash64-with-seed STRING SEED

Hash function for a byte array. For convenience, a 64-bit seed is also hashed into the result. May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Function: farmhash64-with-seeds STRING SEED0 SEED1

Hash function for a byte array. For convenience, two seeds are also hashed into the result. May change from time to time, may differ on different platforms, may differ depending on NDEBUG.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)


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

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *cc*
Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Special Variable: *ext-path*
Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Special Variable: *root-path*
Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: define-farmhash-function NAME RETURN-TYPE DOCSTRING &rest OTHER-ARGS

A macro that helps define Farmhash API functions.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: split-128bit-number-to-64bit NUMBER

Given a number, retruns its low 64bit and high 64bit.

Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Classes

Class: uint128-tclass ()
Package

cl-libfarmhash

Source

cl-libfarmhash.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Direct methods

translate-from-foreign (method)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-libfarmhash.asd: The cl-libfarmhash<dot>asd file
cl-libfarmhash/src: The cl-libfarmhash/src module
cl-libfarmhash/src/cl-libfarmhash.lisp: The cl-libfarmhash/src/cl-libfarmhash<dot>lisp file

F
File, Lisp, cl-libfarmhash.asd: The cl-libfarmhash<dot>asd file
File, Lisp, cl-libfarmhash/src/cl-libfarmhash.lisp: The cl-libfarmhash/src/cl-libfarmhash<dot>lisp file

L
Lisp File, cl-libfarmhash.asd: The cl-libfarmhash<dot>asd file
Lisp File, cl-libfarmhash/src/cl-libfarmhash.lisp: The cl-libfarmhash/src/cl-libfarmhash<dot>lisp file

M
Module, cl-libfarmhash/src: The cl-libfarmhash/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   D   F   M   S  
Index Entry  Section

D
define-farmhash-function: Internal macros

F
farmhash: Exported functions
farmhash-fingerprint128: Exported functions
farmhash-fingerprint32: Exported functions
farmhash-fingerprint64: Exported functions
farmhash128: Exported functions
farmhash128-with-seed: Exported functions
farmhash32: Exported functions
farmhash32-with-seed: Exported functions
farmhash64: Exported functions
farmhash64-with-seed: Exported functions
farmhash64-with-seeds: Exported functions
Function, farmhash: Exported functions
Function, farmhash-fingerprint128: Exported functions
Function, farmhash-fingerprint32: Exported functions
Function, farmhash-fingerprint64: Exported functions
Function, farmhash128: Exported functions
Function, farmhash128-with-seed: Exported functions
Function, farmhash32: Exported functions
Function, farmhash32-with-seed: Exported functions
Function, farmhash64: Exported functions
Function, farmhash64-with-seed: Exported functions
Function, farmhash64-with-seeds: Exported functions
Function, split-128bit-number-to-64bit: Internal functions

M
Macro, define-farmhash-function: Internal macros

S
split-128bit-number-to-64bit: Internal functions

Jump to:   D   F   M   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*cc*: Internal special variables
*ext-path*: Internal special variables
*root-path*: Internal special variables

S
Special Variable, *cc*: Internal special variables
Special Variable, *ext-path*: Internal special variables
Special Variable, *root-path*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S   U  
Index Entry  Section

C
cl-libfarmhash: The cl-libfarmhash system
cl-libfarmhash: The cl-libfarmhash package
cl-libfarmhash-asd: The cl-libfarmhash-asd package
Class, uint128-tclass: Internal classes

P
Package, cl-libfarmhash: The cl-libfarmhash package
Package, cl-libfarmhash-asd: The cl-libfarmhash-asd package

S
System, cl-libfarmhash: The cl-libfarmhash system

U
uint128-tclass: Internal classes

Jump to:   C   P   S   U