Loving Common Lisp, or the Savvy Programmer's Secret Weapon

Loving Common Lisp, or the Savvy Programmer's Secret Weapon
Loving Common Lisp, or the Savvy Programmer's Secret Weapon
Buy on Leanpub

Table of Contents

Copyright 2011-2017 Mark Watson. All rights reserved. This book may be shared using the Creative Commons “share and share alike, no modifications, no commercial reuse” license.

This eBook will be updated occasionally so please periodically check the leanpub.com web page for this book for updates.

This is the fourth edition released May 2017.

Please visit the author’s website.

If you found a copy of this book on the web and find it of value then please consider buying a copy at leanpub.com/lovinglisp to support the author and fund work for future updates.

Preface for the Fourth Edition of “Loving Common Lisp, or the Savvy Programmer’s Secret Weapon”

Why Common Lisp? Isn’t Common Lisp an old language? Do many people still use Common Lisp?

I believe that using Lisp languages like Common Lisp, Clojure, Racket, and Scheme are all secret weapons useful in agile software development. An interactive development process and live production updates feel like a breath of fresh air if you have development on heavy weight like Java Enterprise Edition (JEE).

Yes, Common Lisp is an old language but with age comes stability and extremely good compiler technology. There is also a little inconsistency between different Common Lisp systems in such things as handling threads but with a little up front knowledge you can choose which Common Lisp systems will support your requirements.

A Request from the Author

I spent time writing this book to help you, dear reader. I release this book under the Creative Commons “share and share alike, no modifications, no commercial reuse” license and set the minimum purchase price to $4.00 in order to reach the most readers. Under this license you can share a PDF version of this book with your friends and coworkers. If you found this book on the web (or it was given to you) and if it provides value to you then please consider doing one of the following to support my future writing efforts and also to support future updates to this book:

I enjoy writing and your support helps me write new editions and updates for my books and to develop new book projects. Thank you!

Book editions

The (latest) fourth edition of this book was released in May 2017 and the major changes are:

  • Added a backpropagation neural network example
  • Added a deep learning example using the Java based Armed Bear Common Lisp with the popular DeepLearning4j library
  • Added a heuristic search example
  • Added two machine learning examples (K-Means clustering and SVM classification) using the CLML library
  • A few edits to the previous text

The third edition was released in October 2014. The second edition was released in 2013. the major changes made in the 2014 edition are:

  • I reworked the chapter Common Lisp Basics.
  • I added material to the chapter on using QuickLisp.

Acknowledgments

I would like to thank Jans Aasman for contributing as technical editor for the fourth edition of this book. Jans is CEO of Franz.com which sells Allegro Common Lisp as well as tools for semantic web and linked data applications.

I would like to thank the following people who made suggestions for improving previous editions of this book:

Sam Steingold, Andrew Philpot, Kenny Tilton, Mathew Villeneuve, Eli Draluk, Erik Winkels, Adam Shimali, and Paolo Amoroso.

I would like to also thank several people who pointed out typo errors in this book and for specific suggestions: Martin Lightheart, Tong-Kiat Tan, and Rainer Joswig.

I would like to thank Paul Graham for coining the phrase “The Secret Weapon” (in his excellent paper “Beating the Averages”) in discussing the advantages of Lisp.

I would especially like to thank my wife Carol Watson for her fine work in editing this book.

Introduction

This book is intended to get you, the reader, programming quickly in Common Lisp. Although the Lisp programming language is often associated with artificial intelligence, this is not a book on artificial intelligence.

The Common Lisp program examples are distributed on the github repo for this book.

Why Did I Write this Book?

Why the title “Loving Common Lisp”? Simple! I have been using Lisp for over 30 years and seldom do I find a better match between a programming language and the programming job at hand. I am not a total fanatic on Lisp however. I like both Ruby, Java and Javascript for server side programming, and the few years that I spent working on Nintendo video games and virtual reality systems for SAIC and Disney, I found C++ to be a good bet because of stringent runtime performance requirements. For some jobs, I find the logic-programming paradigm useful: I also enjoy the Prolog language.

In any case, I love programming in Lisp, especially the industry standard Common Lisp. As I wrote the second edition of this book, I had been using Common Lisp almost exclusively for an artificial intelligence project for a health care company and for commercial product development. While working on the third edition of this book, I was not using Common Lisp professionally but since the release of the Quicklisp Common Lisp package manager I have found myself enjoying using Common Lisp more for small side projects. I use Quicklisp throughout in the new third edition example code so you can easily install required libraries.

As programmers, we all (hopefully) enjoy applying our experience and brains to tackling interesting problems. My wife and I recently watched a two-night 7-hour PBS special “Joseph Campbell, and the Power of Myths.” Campbell, a college professor for almost 40 years, said that he always advised his students to “follow their bliss” and not to settle for jobs and avocations that are not what they truly want to do. That said I always feel that when a job calls for using Java or other languages besides Lisp, that even though I may get a lot of pleasure from the job I am not following my bliss.

My goal in this book is to introduce you to one of my favorite programming languages, Common Lisp. I assume that you already know how to program in another language but if you are a complete beginner you can still master the material in this book with some effort. I challenge you to make this effort.

Free Software Tools for Common Lisp Programming

There are several Common Lisp compilers and runtime tools available for free on the web:

  • CLISP – licensed under the GNU GPL and is available for Windows, Macintosh, and Linux/Unix
  • Clozure Common Lisp – open source with good Mac OS X and Linux support
  • CMU Common Lisp – open source implementation
  • SBCL – derived from CMU Common Lisp
  • ECL – compiles using a separate C/C++ compiler
  • ABCL – Armed Bear Common Lisp for the JVM

There are also fine commercial Common Lisp products:

  • LispWorks – high quality and reasonably priced system for Windows and Linux. No charge for distributing compiled applications lispworks.com
  • Allegro Common Lisp - high quality, great support and higher cost. franz.com
  • MCL – Macintosh Common Lisp. I used this Lisp environment in the late 1980s. MCL was so good that I gave away my Xerox 1108 Lisp Machine and switched to a Mac and MCL for my development work. Now open source but only runs on the old MacOS

For working through this book, I will assume that you are using SBCL.

How is Lisp Different from Languages like Java and C++?

This is a trick question! Lisp is slightly more similar to Java than C++ because of automated memory management so we will start by comparing Lisp and Java.

In Java, variables are strongly typed while in Common Lisp values are strongly typed. For example, consider the Java code:

1   Float x = new Float(3.14f);
2   String s = "the cat ran" ;
3   Object any_object = null;
4   any_object = s;
5   x = s;  // illegal: generates a
6           // compilation error

Here, in Java, variables are strongly typed so a variable x of type Float can not legally be assigned a string value: the code in line 5 would generate a compilation error.

Java and Lisp both provide automatic memory management. In either language, you can create new data structures and not worry about freeing memory when the data is no longer used, or to be more precise, is no longer referenced.

Common Lisp is an ANSI standard language. Portability between different Common Lisp implementations and on different platforms is very good. I use Clozure Common Lisp, SBCL, Allegro Lisp (from Franz Inc), LispWorks, and Clisp that all run well on Windows,Mac OS X, and Linux. As a Common Lisp developer you will have great flexibility in tools and platforms.

ANSI Common Lisp was the first object oriented language to become an ANSI standard language. The Common Lisp Object System (CLOS) is probably the best platform for object oriented programming.

In C++ programs, a common bug that affects a program’s efficiency is forgetting to free memory that is no longer used. In a virtual memory system, the effect of a program’s increasing memory usage is usually just poorer system performance but can lead to system crashes or failures if all available virtual memory is exhausted. A worse type of C++ error is to free memory and then try to use it. Can you say “program crash”? C programs suffer from the same types of memory related errors.

Since computer processing power is usually much less expensive than the costs of software development, it is almost always worth while to give up a few percent of runtime efficiency and let the programming environment of runtime libraries manage memory for you. Languages like Lisp, Ruby, Python, and Java are said to perform automatic garbage collection.

I have written six books on Java, and I have been quoted as saying that for me, programming in Java is about twice as efficient (in terms of my time) as programming in C++. I base this statement on approximately ten years of C++ experience on projects for SAIC, PacBell, Angel Studios, Nintendo, and Disney. I find Common Lisp and other Lisp languages like Clojure and Scheme to be about twice as efficient (again, in terms of my time) as Java. That is correct: I am claiming a four times increase in my programming productivity when using Common Lisp vs. C++.

What do I mean by programming productivity? Simple: for a given job, how long it take me to design, code, debug, and later maintain the software for a given task.

Advantages of Working in a Lisp Environment

We will soon see that Lisp is not just a language; it is also a programming environment and runtime environment.

The beginning of this book introduces the basics of Lisp programming. In later chapters, we will develop interesting and non-trivial programs in Common Lisp that I argue would be more difficult to implement in other languages and programming environments.

The big win in programming in a Lisp environment is that you can set up an environment and interactively write new code and test new code in small pieces. We will cover programming with large amounts of data in the Chapter on Natural Language Processing, but let me share a use this general case for work that I do that is far more efficient in Lisp:

Much of my Lisp programming used to be writing commercial natural language processing (NLP) programs for my company www.knowledgebooks.com. My Lisp NLP code uses a huge amount of memory resident data; for example: hash tables for different types of words, hash tables for text categorization, 200,000 proper nouns for place names (cities, counties, rivers, etc.), and about 40,000 common first and last names of various nationalities. If I was writing my NLP products in C++, I would probably use a relational database to store this data because if I read all of this data into memory for each test run of a C++ program, I would wait 30 seconds every time that I ran a program test. When I start working in any Common Lisp environment, I do have to load the linguistic data into memory one time, but then can code/test/code/test… for hours with no startup overhead for reloading the data that my programs need to run. Because of the interactive nature of Lisp development, I can test small bits of code when tracking down errors in the code.

It is a personal preference, but I find the combination of the stable Common Lisp language and an iterative Lisp programming environment to be much more productive than, for example, the best Java IDEs (e.g., IntelliJ Idea is my favorite) and Microsoft’s VisualStudio.Net.

Common Lisp Basics

The material in this chapter will serve as an introduction to Common Lisp. I have attempted to make this book a self contained resource for learning Common Lisp and to provide code examples to perform common tasks. If you already know Common Lisp and bought this book for the code examples that the text that explains the examples then you can probably skip this chapter.

For working through this chapter we will be using the interactive shell, or repl, built into SBCL and other Common Lisp systems. For this chapter it is sufficient for you to download and install SBCL. Please install SBCL right now, if you have not already done so.

Getting Started with SBCL

When we start SBCL, we see a introductory message and then an input prompt. We will start with a short tutorial, walking you through a session using SBCL repl (other Common LISP systems are very similar). A repl is an interactive console where you type expressions and see the results of evaluating these expressions. An expression can be a large block of code pasted into the repl, using the load function to load Lisp code into the repl, calling functions to test them, etc. Assuming that SBCL is installed on your system, start SBCL by running the SBCL program:

 1 % sbcl
 2 (running SBCL from: /Users/markw/sbcl)
 3 This is SBCL 1.1.8.0-19cda10, an implementation of ANSI Common Lisp.
 4 More information about SBCL is available at <http://www.sbcl.org/>.
 5 
 6 SBCL is free software, provided as is, with absolutely no warranty.
 7 It is mostly in the public domain; some portions are provided under
 8 BSD-style licenses.  See the CREDITS and COPYING files in the
 9 distribution for more information.
10 
11 * (defvar x 1.0)
12 
13 X
14 * x
15 
16 1.0
17 * (+ x 1)
18 
19 2.0
20 * x
21 
22 1.0
23 * (setq x (+ x 1))
24 
25 2.0
26 * x
27 
28 2.0
29 * (setq x "the dog chased the cat")
30 
31 "the dog chased the cat"
32 * x
33 
34 "the dog chased the cat"
35 * (quit)

We started by defining a new variable x in line 11. Notice how the value of the defvar macro is the symbol that is defined. The Lisp reader prints X capitalized because symbols are made upper case (we will look at the exception later).

In Lisp, a variable can reference any data type. We start by assigning a floating point value to the variable x, using the + function to add 1 to x in line 17, using the setq function to change the value of x in lines 23 and 29 first to another floating point value and finally setting x to a string value. One thing that you will have noticed: function names always occur first, then the arguments to a function. Also, parenthesis is used to separate expressions.

I learned to program Lisp in 1976 and my professor half-jokingly told us that Lisp was an acronym for “Lots-of Irritating Superfluous Parenthesis.” There may be some truth in this when you are just starting with Lisp programming, but you will quickly get used to the parenthesis, especially if you use an editor like Emacs that automatically indents Lisp code for you and highlights the opening parenthesis for every closing parenthesis that you type. Many other editors also support coding in Lisp but we will only cover the use of Emacs in this web book. Newer versions of Emacs and XEmacs also provide colored syntax highlighting of Lisp code.

Before you proceed to the next chapter, please take the time to install SBCL on your computer and try typing some expressions into the Lisp listener. If you get errors, or want to quit, try using the quit function:

1 * (+ 1 2 3 4)
2 
3 10
4 * (quit)
5 Bye.

As we discussed in the introduction, there are many different Lisp programming environments that you can choose from. I recommend a free set of tools: Emacs, slime, and SBCL. Emacs is a fine text editor that is extensible to work well with many programming languages and document types (e.g., HTML and XML). Slime is a Emacs extension package that greatly facilitates Lisp development. SBCL is a robust Common Lisp compiler and runtime system.

We will cover the Quicklisp package manager and using Quicklisp to setup Slime and Emacs in the next chapter.

I will not spend much time covering the use of Emacs as a text editor in this book since you can try most of the example code snippets in the book text by copying then and pasting them into a SBCL repl and by loading the book example source files directly into a repl. If you already use Emacs then I recommend that you do set up Slime sooner rather than later and start using it for development. If you are not already an Emacs user and do not mind spending the effort to learn Emacs, then search the web first for an Emacs tutorial. That said, you will be able to use the example code from this book just fine using any text editor you like with a SBCL repl. I don’t use the vi or vim editors but if vi is your weapon of choice for editing text then a web search for “common lisp vi vim repl” should get you going for developing Common Lisp code with vi or vim.

Here, we will assume that under Windows, Unix, Linux, or Mac OS X you will use one command window to run SBCL and a separate editor that can edit plain text files.

Making the repl Nicer using rlwrap

While reading the last section you (hopefully!) played with the SBCL interactive repl. If you haven’t played with the repl, I won’t get too judgmental except to say that if you do not play with the book examples as you read you will not get the full benefit from this book.

Did you notice that the backspace key does not work in the SBCL repl? The way to fix this is to install the GNU rlwrap utility. On OS X, assuming that you have homebrew installed, install rlwrap with:

1 brew install rlwrap

If you are running Ubuntu Linux, install rlwrap using:

1 sudo apt-get install rlwrap

You can then create an alias for bash or zsh using something like the following to define a command rsbcl:

1 alias rsbcl='rlwrap sbcl'

This is fine, just remember to run sbcl if you don’t need rlwrap command line editing or run rsbcl when you do need command line editing. That said, I find that I always want to run SBCL with command line editing, so I redefine sbcl on my computers using:

1 ->  ~  which sbcl
2 /Users/markw/sbcl/sbcl
3 ->  ~  alias sbcl='rlwrap /Users/markw/sbcl/sbcl'

This alias is different on my laptops and servers, since I don’t usually install SBCL in the default installation directory. For each of my computers, I add an appropriate alias in my .zshrc file (if I am running zsh) or my .bashrc file (if I am running bash).

The Basics of Lisp Programming

Although we will use SBCL in this book, any Common Lisp environment will do fine. In previous sections, we saw the top-level Lisp prompt and how we could type any expression that would be evaluated:

 1 * 1
 2 1
 3 * 3.14159
 4 3.14159
 5 * "the dog bit the cat"
 6 "the dog bit the cat"
 7 * (defun my-add-one (x)
 8 (+ x 1))
 9 MY-ADD-ONE
10 * (my-add-one -10)
11 -9

Notice that when we defined the function my-add-one in lines 7 and 8, we split the definition over two lines and on line 8 you don’t see the “*” prompt from SBCL – this lets you know that you have not yet entered a complete expression. The top level Lisp evaluator counts parentheses and considers a form to be complete when the number of closing parentheses equals the number of opening parentheses and an expression is complete when the parentheses match. I tend to count in my head, adding one for every opening parentheses and subtracting one for every closing parentheses – when I get back down to zero then the expression is complete. When we evaluate a number (or a variable), there are no parentheses, so evaluation proceeds when we hit a new line (or carriage return).

The Lisp reader by default tries to evaluate any form that you enter. There is a reader macro that prevents the evaluation of an expression. You can either use the character or quote:

1 * (+ 1 2)
2 3
3 * '(+ 1 2)
4 (+ 1 2)
5 * (quote (+ 1 2))
6 (+ 1 2)
7 * 

Lisp supports both global and local variables. Global variables can be declared using defvar:

 1 * (defvar *x* "cat")
 2 *X*
 3 * *x*
 4 "cat"
 5 * (setq *x* "dog")
 6 "dog"
 7 * *x*
 8 "dog"
 9 * (setq *x* 3.14159)
10 3.14159
11 * *x*
12 3.14159

One thing to be careful of when defining global variables with defvar: the declared global variable is dynamically scoped. We will discuss dynamic versus lexical scoping later, but for now a warning: if you define a global variable avoid redefining the same variable name inside functions. Lisp programmers usually use a global variable naming convention of beginning and ending dynamically scoped global variables with the * character. If you follow this naming convention and also do not use the * character in local variable names, you will stay out of trouble. For convenience, I do not always follow this convention in short examples in this book.

Lisp variables have no type. Rather, values assigned to variables have a type. In this last example, the variable x was set to a string, then to a floating-point number. Lisp types support inheritance and can be thought of as a hierarchical tree with the type t at the top. (Actually, the type hierarchy is a DAG, but we can ignore that for now.) Common Lisp also has powerful object oriented programming facilities in the Common Lisp Object System (CLOS) that we will discuss in a later chapter.

Here is a partial list of types (note that indentation denotes being a subtype of the preceding type):

 1 t  [top level type (all other types are a sub-type)]
 2      sequence
 3           list
 4           array
 5                vector
 6                     string
 7      number
 8           float
 9           rational
10                integer
11                ratio
12           complex
13      character
14      symbol
15      structure
16      function
17      hash-table

We can use the typep function to test the type of value of any variable or expression:

 1 * (setq x '(1 2 3))
 2 (1 2 3)
 3 * (typep x 'list)
 4 T
 5 * (typep x 'sequence)
 6 T
 7 * (typep x 'number)
 8 NIL
 9 * (typep (+ 1 2 3) 'number)
10 T
11 *

A useful feature of all ANSI standard Common Lisp implementations’ top-level listener is that it sets * to the value of the last expression evaluated. For example:

1 * (+ 1 2 3 4 5)
2 15
3 * *
4 15
5 * (setq x *)
6 15
7 * x
8 15

All Common Lisp environments set * to the value of the last expression evaluated. This example may be slightly confusing because * is also the prompt character in the SBCL repl that indicates that you can enter a new expression for evaluation. For example in line 3, the first * character is the repl prompt and the second * we type in to see that value of the previous expression that we typed into the repl.

Frequently, when you are interactively testing new code, you will call a function that you just wrote with test arguments; it is useful to save intermediate results for later testing. It is the ability to create complex data structures and then experiment with code that uses or changes these data structures that makes Lisp programming environments so effective.

Common Lisp is a lexically scoped language that means that variable declarations and function definitions can be nested and that the same variable names can be used in nested let forms; when a variable is used, the current let form is searched for a definition of that variable and if it is not found, then the next outer let form is searched. Of course, this search for the correct declaration of a variable is done at compile time so there need not be extra runtime overhead. We can nest defun special form inside each other and inside let expressions. We cam also use the special forms flet and labels to define functions inside a scoped environment. Functions defined inside a labels special form can be recursive while functions defined inside a flet special form can not be recursive. Consider the following example in the file nested.lisp (all example files are in the src directory):

 1 (flet ((add-one (x)
 2          (+ x 1))
 3        (add-two (x)
 4          (+ x 2)))
 5   (format t "redefined variables: ~A  ~A~%" (add-one 100) (add-two 100)))
 6 
 7 (let ((a 3.14))
 8   (defun test2 (x)
 9     (print x))
10   (test2 a))
11 
12 (test2 50)
13 
14 (let ((x 1)
15       (y 2))
16   ;; define a test function nested inside a let statement:
17   (flet ((test (a b)
18            (let ((z (+ a b)))
19              ;; define a helper function nested inside a let/function/let:
20              (flet ((nested-function (a)
21                       (+ a a)))
22                (nested-function z)))))
23     ;; call nested function 'test':
24     (format t "test result is ~A~%" (test x y))))
25 
26 (let ((z 10))
27   (labels ((test-recursion (a)
28              (format t "test-recursion ~A~%" (+ a z))
29              (if (> a 0)
30                  (test-recursion (- a 1)))))
31     (test-recursion 5)))

We define a top level flet special form in lines 1-5 that defines two nested functions add-one and add-two and then calls each nested function in the body of the flet special form. For many years I have used nested defun special forms inside let expressions for defining local functions and you will notice this use in a few later examples. However, functions defined inside defun special forms have global visibility so they are not hidden in the local context where they are defined. The example of a nested defun in lines 7-12 shows that the function test2 has global visibility inside the current package.

Functions defined inside of a flet special form have access to variables defined in the outer scope containing the flet (also aplies to labels). We see this in lines 14-24 where the local variables x and y defined in the let expression are visible inside the function nested-function defined inside the flet.

The final exaple in lines 26-31 shows a recursive function defined inside a labels special form.

Assuming that we started SBCL in the src directory we can then use the Lisp load function to evaluate the contents of the file nested.lisp using the load function:

* (load "nested.lisp")
redefined variables: 101  102

3.14 
50 test result is 6
test-recursion 15
test-recursion 14
test-recursion 13
test-recursion 12
test-recursion 11
test-recursion 10
T
*

The function load returned a value of t (prints in upper case as T) after successfully loading the file.

We will use Common Lisp vectors and arrays frequently in later chapters, but will also briefly introduce them here. A singly dimensioned array is also called a vector. Although there are often more efficient functions for handling vectors, we will just look at generic functions that handle any type of array, including vectors. Common Lisp provides support for functions with the same name that take different argument types; we will discuss this in some detail when we cover this in the later chapter on CLOS. We will start by defining three vectors v1, v2, and v3:

1 * (setq v1 (make-array '(3)))
2 #(NIL NIL NIL)
3 * (setq v2 (make-array '(4) :initial-element "lisp is good"))
4 #("lisp is good" "lisp is good" "lisp is good" "lisp is good")
5 * (setq v3 #(1 2 3 4 "cat" '(99 100)))
6 #(1 2 3 4 "cat" '(99 100))

In line 1, we are defining a one-dimensional array, or vector, with three elements. In line 3 we specify the default value assigned to each element of the array v2. In line 5 I use the form for specifying array literals using the special character #. The function aref can be used to access any element in an array:

* (aref v3 3)
4
* (aref v3 5)
'(99 100)
* 

Notice how indexing of arrays is zero-based; that is, indices start at zero for the first element of a sequence. Also notice that array elements can be any Lisp data type. So far, we have used the special operator setq to set the value of a variable. Common Lisp has a generalized version of setq called setf that can set any value in a list, array, hash table, etc. You can use setf instead of setq in all cases, but not vice-versa. Here is a simple example:

* v1
#(NIL NIL NIL)
* (setf (aref v1 1) "this is a test") 
"this is a test"
* v1
#(NIL "this is a test" NIL)
* 

When writing new code or doing quick programming experiments, it is often easiest (i.e., quickest to program) to use lists to build interesting data structures. However, as programs mature, it is common to modify them to use more efficient (at runtime) data structures like arrays and hash tables.

Symbols

We will discuss symbols in more detail the Chapter on Common Lisp Packages. For now, it is enough for you to understand that symbols can be names that refer to variables. For example:

> (defvar *cat* "bowser")
*CAT*
* *cat*
"bowser"
* (defvar *l* (list *cat*))
*L*
* *l*
("bowser")
*

Note that the first defvar returns the defined symbol as its value. Symbols are almost always converted to upper case. An exception to this “upper case rule” is when we define symbols that may contain white space using vertical bar characters:

* (defvar |a symbol with Space Characters| 3.14159)
|a symbol with Space Characters|
* |a symbol with Space Characters|
3.14159
* 

Operations on Lists

Lists are a fundamental data structure of Common Lisp. In this section, we will look at some of the more commonly used functions that operate on lists. All of the functions described in this section have something in common: they do not modify their arguments.

In Lisp, a cons cell is a data structure containing two pointers. Usually, the first pointer in a cons cell will point to the first element in a list and the second pointer will point to another cons representing the start of the rest of the original list.

The function cons takes two arguments that it stores in the two pointers of a new cons data structure. For example:

* (cons 1 2)
(1 . 2)
* (cons 1 '(2 3 4))
(1 2 3 4)
* 

The first form evaluates to a cons data structure while the second evaluates to a cons data structure that is also a proper list. The difference is that in the second case the second pointer of the freshly created cons data structure points to another cons cell.

First, we will declare two global variables l1 and l2 that we will use in our examples. The list l1 contains five elements and the list l2 contains four elements:

* (defvar l1 '(1 2 (3) 4 (5 6)))
L1
* (length l1)

5
* (defvar l2 '(the "dog" calculated 3.14159))
L2
* l1
(1 2 (3) 4 (5 6))
* l2
(THE "dog" CALCULATED 3.14159)
>

You can also use the function list to create a new list; the arguments passed to function list are the elements of the created list:

* (list 1 2 3 'cat "dog")
(1 2 3 CAT "dog")
*

The function car returns the first element of a list and the function cdr returns a list with its first element removed (but does not modify its argument):

* (car l1)
1
* (cdr l1)
(2 (3) 4 (5 6))
*

Using combinations of car and cdr calls can be used to extract any element of a list:

* (car (cdr l1))
2
* (cadr l1)
2
*

Notice that we can combine calls to car and cdr into a single function call, in this case the function cadr. Common Lisp defines all functions of the form cXXr, cXXXr, and cXXXXr where X can be either a or d.

Suppose that we want to extract the value 5 from the nested list l1. Some experimentation with using combinations of car and cdr gets the job done:

* l1
(1 2 (3) 4 (5 6))
* (cadr l1)
2
* (caddr l1)
(3)
(car (caddr l1))
3
* (caar (last l1))
5
* (caar (cddddr l1))

5
*

The function last returns the last cdr of a list (i.e., the last element, in a list):

* (last l1)
((5 6))
*

Common list supplies alternative functions to car and cdr that you might find more readable: first, second, third, fourth, and rest. Here are some examples:

* (defvar *x* '(1 2 3 4 5))

*X*
* (first *x*)

1
* (rest *x*)

(2 3 4 5)
* (second *x*)

2
* (third *x*)

3
* (fourth *x*)

4

The function nth takes two arguments: an index of a top-level list element and a list. The first index argument is zero based:

* l1
(1 2 (3) 4 (5 6))
* (nth 0 l1)
1
* (nth 1 l1)
2
* (nth 2 l1)
(3)
*

The function cons adds an element to the beginning of a list and returns as its value a new list (it does not modify its arguments). An element added to the beginning of a list can be any Lisp data type, including another list:

* (cons 'first l1)
(FIRST 1 2 (3) 4 (5 6))
* (cons '(1 2 3) '(11 22 33))
((1 2 3) 11 22 33)
* 

The function append takes two lists as arguments and returns as its value the two lists appended together:

* l1
(1 2 (3) 4 (5 6))
* l2
('THE "dog" 'CALCULATED 3.14159)
* (append l1 l2)
(1 2 (3) 4 (5 6) THE "dog" CALCULATED 3.14159)
* (append '(first) l1)
(FIRST 1 2 (3) 4 (5 6))
* 

A frequent error that beginning Lisp programmers make is not understanding shared structures in lists. Consider the following example where we generate a list y by reusing three copies of the list x:

* (setq x '(0 0 0 0))
(0 0 0 0)
* (setq y (list x x x))
((0 0 0 0) (0 0 0 0) (0 0 0 0))
* (setf (nth 2 (nth 1 y)) 'x)
X
* x
(0 0 X 0)
* y
((0 0 X 0) (0 0 X 0) (0 0 X 0))
* (setq z '((0 0 0 0) (0 0 0 0) (0 0 0 0)))
((0 0 0 0) (0 0 0 0) (0 0 0 0))
* (setf (nth 2 (nth 1 z)) 'x)
X
* z
((0 0 0 0) (0 0 X 0) (0 0 0 0))
* 

When we change the shared structure referenced by the variable x that change is reflected three times in the list y. When we create the list stored in the variable z we are not using a shared structure.

Using Arrays and Vectors

Using lists is easy but the time spent accessing a list element is proportional to the length of the list. Arrays and vectors are more efficient at runtime than long lists because list elements are kept on a linked-list that must be searched. Accessing any element of a short list is fast, but for sequences with thousands of elements, it is faster to use vectors and arrays.

By default, elements of arrays and vectors can be any Lisp data type. There are options when creating arrays to tell the Common Lisp compiler that a given array or vector will only contain a single data type (e.g., floating point numbers) but we will not use these options in this book.

Vectors are a specialization of arrays; vectors are arrays that only have one dimension. For efficiency, there are functions that only operate on vectors, but since array functions also work on vectors, we will concentrate on arrays. In the next section, we will look at character strings that are a specialization of vectors.

We could use the generalized make-sequence function to make a singularly dimensioned array (i.e., a vector). Restart sbcl and try:

* (defvar x (make-sequence 'vector 5 :initial-element 0))
X
* x
#(0 0 0 0 0)
* 

In this example, notice the print format for vectors that looks like a list with a proceeding # character. As seen in the last section, we use the function make-array to create arrays:

* (defvar y (make-array '(2 3) :initial-element 1))
Y
* y
#2A((1 1 1) (1 1 1))
>

Notice the print format of an array: it looks like a list proceeded by a # character and the integer number of dimensions.

Instead of using make-sequence to create vectors, we can pass an integer as the first argument of make-array instead of a list of dimension values. We can also create a vector by using the function vector and providing the vector contents as arguments:

* (make-array 10)  
#(NIL NIL NIL NIL NIL NIL NIL NIL NIL NIL)
* (vector 1 2 3 'cat)
#(1 2 3 CAT)
* 

The function aref is used to access sequence elements. The first argument is an array and the remaining argument(s) are array indices. For example:

* x
#(0 0 0 0 0)
* (aref x 2)
0
* (setf (aref x 2) "parrot")
"parrot"
* x
#(0 0 "parrot" 0 0)
* (aref x 2)
"parrot"
* y
#2A((1 1 1) (1 1 1))
* (setf (aref y 1 2) 3.14159)
3.14159
* y
#2A((1 1 1) (1 1 3.14159))
* 

Using Strings

It is likely that even your first Lisp programs will involve the use of character strings. In this section, we will cover the basics: creating strings, concatenating strings to create new strings, for substrings in a string, and extracting substrings from longer strings. The string functions that we will look at here do not modify their arguments; rather, they return new strings as values. For efficiency, Common Lisp does include destructive string functions that do modify their arguments but we will not discuss these destructive functions here.

We saw earlier that a string is a type of vector, which in turn is a type of array (which in turn is a type of sequence). A full coverage of the Common Lisp type system is outside the scope of this tutorial introduction to Common Lisp; a very good treatment of Common Lisp types is in Guy Steele’s “Common Lisp, The Language” which is available both in print and for free on the web. Many of the built in functions for handling strings are actually more general because they are defined for the type sequence. The Common Lisp Hyperspec is another great free resource that you can find on the web. I suggest that you download an HTML version of Guy Steele’s excellent reference book and the Common Lisp Hyperspec and keep both on your computer. If you continue using Common Lisp, eventually you will want to read all of Steele’s book and use the Hyperspec for reference.

The following text was captured from input and output from a Common Lisp repl. First, we will declare two global variables s1 and space that contain string values:

* (defvar s1 "the cat ran up the tree")
S1
* (defvar space " ")
SPACE
* 

One of the most common operations on strings is to concatenate two or more strings into a new string:

* (concatenate 'string s1 space "up the tree")
"the cat ran up the tree up the tree"
*

Notice that the first argument of the function concatenate is the type of the sequence that the function should return; in this case, we want a string. Another common string operation is search for a substring:

* (search "ran" s1)
8
* (search "zzzz" s1)
NIL
*

If the search string (first argument to function search) is not found, function search returns nil, otherwise search returns an index into the second argument string. Function search takes several optional keyword arguments (see the next chapter for a discussion of keyword arguments):

  (search search-string a-longer-string :from-end :test
                                        :test-not :key
                                        :start1 :start2
                                        :end1 :end2)

For our discussion, we will just use the keyword argument :start2 for specifying the starting search index in the second argument string and the :from-end flag to specify that search should start at the end of the second argument string and proceed backwards to the beginning of the string:

* (search " " s1)
3
* (search " " s1 :start2 5)
7
* (search " " s1 :from-end t)
18
*

The sequence function subseq can be used for strings to extract a substring from a longer string:

* (subseq s1 8)
"ran up the tree"
>

Here, the second argument specifies the starting index; the substring from the starting index to the end of the string is returned. An optional third index argument specifies one greater than the last character index that you want to extract:

* (subseq s1 8 11)
"ran"
*

It is frequently useful to remove white space (or other) characters from the beginning or end of a string:

* (string-trim '(#\space #\z #\a) " a boy said pez")
"boy said pe"
* 

The character #\space is the space character. Other common characters that are trimmed are #\tab and #\newline. There are also utility functions for making strings upper or lower case:

* (string-upcase "The dog bit the cat.")
"THE DOG BIT THE CAT."
* (string-downcase "The boy said WOW!")
"the boy said wow!"
>

We have not yet discussed equality of variables. The function eq returns true if two variables refer to the same data in memory. The function eql returns true if the arguments refer to the same data in memory or if they are equal numbers or characters. The function equal is more lenient: it returns true if two variables print the same when evaluated. More formally, function equal returns true if the car and cdr recursively equal to each other. An example will make this clearer:

* (defvar x '(1 2 3))
X
* (defvar y '(1 2 3))
Y
* (eql x y)
NIL
* (equal x y)
T
* x
(1 2 3)
* y
(1 2 3)
* 

For strings, the function string= is slightly more efficient than using the function equal:

* (eql "cat" "cat")
NIL
* (equal "cat" "cat")
T
* (string= "cat" "cat")
T
* 

Common Lisp strings are sequences of characters. The function char is used to extract individual characters from a string:

* s1
"the cat ran up the tree"
* (char s1 0)
#\t
* (char s1 1)
#\h
* 

Using Hash Tables

Hash tables are an extremely useful data type. While it is true that you can get the same effect by using lists and the assoc function, hash tables are much more efficient than lists if the lists contain many elements. For example:

* (defvar x '((1 2) ("animal" "dog")))
X
* (assoc 1 x)
(1 2)
* (assoc "animal" x)
NIL
* (assoc "animal" x :test #'equal)
("animal" "dog")
*

The second argument to function assoc is a list of cons cells. Function assoc searches for a sub-list (in the second argument) that has its car (i.e., first element) equal to the first argument to function assoc. The perhaps surprising thing about this example is that assoc seems to work with an integer as the first argument but not with a string. The reason for this is that by default the test for equality is done with eql that tests two variables to see if they refer to the same memory location or if they are identical if they are numbers. In the last call to assoc we used “:test #’equal” to make assoc use the function equal to test for equality.

The problem with using lists and assoc is that they are very inefficient for large lists. We will see that it is no more difficult to code with hash tables.

A hash table stores associations between key and value pairs, much like our last example using the assoc function. By default, hash tables use eql to test for equality when looking for a key match. We will duplicate the previous example using hash tables:

* (defvar h (make-hash-table))
H
* (setf (gethash 1 h) 2)
2
* (setf (gethash "animal" h) "dog")
"dog"
* (gethash 1 h)
2 ;
T
* (gethash "animal" h)
NIL ;
NIL
*

Notice that gethash returns multiple values: the first value is the value matching the key passed as the first argument to function gethash and the second returned value is true if the key was found and nil otherwise. The second returned value could be useful if hash values are nil.

Since we have not yet seen how to handle multiple returned values from a function, we will digress and do so here (there are many ways to handle multiple return values and we are just covering one of them):

* (multiple-value-setq (a b) (gethash 1 h))
2
* a
2
* b
T
* 

Assuming that variables a and b are already declared, the variable a will be set to the first returned value from gethash and the variable b will be set to the second returned value.

If we use symbols as hash table keys, then using eql for testing for equality with hash table keys is fine:

* (setf (gethash 'bb h) 'aa)
AA
* (gethash 'bb h)
AA ;
T
* 

However, we saw that eql will not match keys with character string values. The function make-hash-table has optional key arguments and one of them will allow us to use strings as hash key values:

  (make-hash-table &key :test :size :rehash-size :rehash-threshold)

Here, we are only interested in the first optional key argument :test that allows us to use the function equal to test for equality when matching hash table keys. For example:

* (defvar h2 (make-hash-table :test #'equal))
H2
* (setf (gethash "animal" h2) "dog")
"dog"
* (setf (gethash "parrot" h2) "Brady")
"Brady"
* (gethash "parrot" h2)
"Brady" ;
T
* 

It is often useful to be able to enumerate all the key and value pairs in a hash table. Here is a simple example of doing this by first defining a function my-print that takes two arguments, a key and a value. We can then use the maphash function to call our new function my-print with every key and value pair in a hash table:

* (defun my-print (a-key a-value)
        (format t "key: ~A value: ~A~\%" a-key a-value))          
MY-PRINT
* (maphash #'my-print h2)
key: parrot value: Brady
key: animal value: dog
NIL
* 

The function my-print is applied to each key/value pair in the hash table. There are a few other useful hash table functions that we demonstrate here:

* (hash-table-count h2)
2
* (remhash "animal" h2)
T
* (hash-table-count h2)
1
* (clrhash h2)
#S(HASH-TABLE EQUAL)
* (hash-table-count h2)
0
* 

The function hash-table-count returns the number of key and value pairs in a hash table. The function remhash can be used to remove a single key and value pair from a hash table. The function clrhash clears out a hash table by removing all key and value pairs in a hash table.

It is interesting to note that clrhash and remhash are the first Common Lisp functions that we have seen so far that modify any of its arguments, except for setq and setf that are macros and not functions.

Using Eval to Evaluate Lisp Forms

We have seen how we can type arbitrary Lisp expressions in the Lisp repl listener and then they are evaluated. We will see in the Chapter on Input and Output that the Lisp function read evaluates lists (or forms) and indeed the Lisp repl uses function read.

In this section, we will use the function eval to evaluate arbitrary Lisp expressions inside a program. As a simple example:

* (defvar x '(+ 1 2 3 4 5))
X
* x
(+ 1 2 3 4 5)
* (eval x)
15
* 

Using the function eval, we can build lists containing Lisp code and evaluate generated code inside our own programs. We get the effect of “data is code”. A classic Lisp program, the OPS5 expert system tool, stored snippets of Lisp code in a network data structure and used the function eval to execute Lisp code stored in the network. A warning: the use of eval is likely to be inefficient in non-compiled code. For efficiency, the OPS5 program contained its own version of eval that only interpreted a subset of Lisp used in the network.

Using a Text Editor to Edit Lisp Source Files

I usually use Emacs, but we will briefly discuss the editor vi also. If you use vi (e.g., enter “vi nested.lisp”) the first thing that you should do is to configure vi to indicate matching opening parentheses whenever a closing parentheses is typed; you do this by typing “:set sm” after vi is running.

If you choose to learn Emacs, enter the following in your .emacs file (or your _emacs file in your home directory if you are running Windows):

1   (set-default 'auto-mode-alist
2                (append '(("\\.lisp$" . lisp-mode)
3                          ("\\.lsp$" . lisp-mode)
4                          ("\\.cl$" . lisp-mode))
5                        auto-mode-alist))

Now, whenever you open a file with the extension of “lisp”, “lsp”, or “cl” (for “Common Lisp”) then Emacs will automatically use a Lisp editing mode. I recommend searching the web using keywords “Emacs tutorial” to learn how to use the basic Emacs editing commands - we will not repeat this information here.

I do my professional Lisp programming using free software tools: Emacs, SBCL, Clozure Common Lisp, and Clojure. I will show you how to configure Emacs and Slime in the last section of the Chapter on Quicklisp.

Recovering from Errors

When you enter forms (or expressions) in a Lisp repl listener, you will occasionally make a mistake and an error will be thrown. Here is an example where I am not showing all of the output when entering help when an error is thrown:

* (defun my-add-one (x) (+ x 1))

MY-ADD-ONE
* (my-add-one 10)

11
* (my-add-one 3.14159)

4.14159
* (my-add-one "cat")

debugger invoked on a SIMPLE-TYPE-ERROR: Argument X is not a NUMBER: "cat"

Type HELP for debugger help, or (SB-EXT:EXIT) to exit from SBCL.

restarts (invokable by number or by possibly-abbreviated name):
  0: [ABORT] Exit debugger, returning to top level.

(SB-KERNEL:TWO-ARG-+ "cat" 1)
0] help

The debug prompt is square brackets, with number(s) indicating the current
  control stack level and, if you've entered the debugger recursively, how
  deeply recursed you are.

 ...

Getting in and out of the debugger:
  TOPLEVEL, TOP  exits debugger and returns to top level REPL
  RESTART        invokes restart numbered as shown (prompt if not given).
  ERROR          prints the error condition and restart cases.

 ...

Inspecting frames:
  BACKTRACE [n]  shows n frames going down the stack.
  LIST-LOCALS, L lists locals in current frame.
  PRINT, P       displays function call for current frame.
  SOURCE [n]     displays frame's source form with n levels of enclosing forms.

Stepping:
  START Selects the CONTINUE restart if one exists and starts
        single-stepping. Single stepping affects only code compiled with
        under high DEBUG optimization quality. See User Manual for details.
  STEP  Steps into the current form.
  NEXT  Steps over the current form.
  OUT   Stops stepping temporarily, but resumes it when the topmost frame that
        was stepped into returns.
  STOP  Stops single-stepping.

 ...

0] list-locals
SB-DEBUG::ARG-0  =  "cat"
SB-DEBUG::ARG-1  =  1

0] backtrace 2

Backtrace for: #<SB-THREAD:THREAD "main thread" RUNNING {1002AC32F3}>
0: (SB-KERNEL:TWO-ARG-+ "cat" 1)
1: (MY-ADD-ONE "cat")
0] :0

*

Here, I first used the backtrace command :bt to print the sequence of function calls that caused the error. If it is obvious where the error is in the code that I am working on then I do not bother using the backtrace command. I then used the abort command :a to recover back to the top level Lisp listener (i.e., back to the greater than prompt). Sometimes, you must type :a more than once to fully recover to the top level greater than prompt.

Garbage Collection

Like other languages like Java and Python, Common Lisp provides garbage collection (GC) or automatic memory management.

In simple terms, GC occurs to free memory in a Lisp environment that is no longer accessible by any global variable (or function closure, which we will cover in the next chapter). If a global variable *variable-1* is first set to a list and then if we later then set *variable-1* to, for example nil, and if the data referenced in the original list is not referenced by any other accessible data, then this now unused data is subject to GC.

In practice, memory for Lisp data is allocated in time ordered batches and ephemeral or generational garbage collectors garbage collect recent memory allocations far more often than memory that has been allocated for a longer period of time.

Loading your Working Environment Quickly

When you start using Common Lisp for large projects, you will likely have many files to load into your Lisp environment when you start working. Most Common Lisp implementations have a function called defsystem that works somewhat like the Unix make utility. While I strongly recommend defsystem for large multi-person projects, I usually use a simpler scheme when working on my own: I place a file loadit.lisp in the top directory of each project that I work on. For any project, its loadit.lisp file loads all source files and initializes any global data for the project.

Another good technique is to create a Lisp image containing all the code and data for all your projects. There is an example of this in the first section of the Chapter on NLP. In this example, it takes a few minutes to load the code and data for my NLP (natural language processing) library so when I am working with it I like to be able to quickly load a SBCL Lisp image.

All Common Lisp implementations have a mechanism for dumping a working image containing code and data.

Functional Programming Concepts

There are two main styles for doing Common Lisp development. Object oriented programming is well supported (see the Chapter on CLOS) as is functional programming. In a nut shell, functional programming means that we should write functions with no side effects. First let me give you a non-functional example with side effects:

(defun non-functional-example (car)
  (set-color car "red"))

This example using CLOS is non-functional because we modify the value of an argument to the function. Some functional languages like the Lisp Clojure language and the Haskell language dissuade you from modifying arguments to functions. With Common Lisp you should make a decision on which approach you like to use.

Functional programming means that we avoid maintaining state inside of functions and treat data as immutable (i.e., once an object is created, it is never modified). We could modify the last example to be function by creating a new car object inside the function, copy the attributes of the car passed as an object, change the color to “red” of the new car object, and return the new car instance as the value of the function.

Functional programming prevents many types of programming errors, makes unit testing simpler, and makes programming for modern multi-core CPUs easier because read-only objects are inherently thread safe. Modern best practices for the Java language also prefer immutable data objects and a functional approach.

Defining Lisp Functions

In the previous chapter, we defined a few simple functions. In this chapter, we will discuss how to write functions that take a variable number of arguments, optional arguments, and keyword arguments.

The special form defun is used to define new functions either in Lisp source files or at the top level Lisp listener prompt. Usually, it is most convenient to place function definitions in a source file and use the function load to load them into our Lisp working environment.

In general, it is bad form to use global variables inside Lisp functions. Rather, we prefer to pass all required data into a function via its argument list and to get the results of the function as the value (or values) returned from a function. Note that if we do require global variables, it is customary to name them with beginning and ending * characters; for example:

1 (defvar *lexical-hash-table*
2         (make-hash-table :test #'equal :size 5000))

Then in this example, if you see the variable *lexical-hash-table* inside a function definition, you will know that at least by naming convention, that this is a global variable.

In Chapter 1, we saw an example of using lexically scoped local variables inside a function definition (in the example file nested.lisp).

There are several options for defining the arguments that a function can take. The fastest way to introduce the various options is with a few examples.

First, we can use the &aux keyword to declare local variables for use in a function definition:

1 * (defun test (x &aux y)
2        (setq y (list x x))
3        y)
4 TEST
5 * (test 'cat)
6 (CAT CAT)
7 * (test 3.14159)
8 (3.14159 3.14159)

It is considered better coding style to use the let special operator for defining auxiliary local variables; for example:

1 * (defun test (x)
2        (let ((y (list x x)))
3          y))
4 TEST
5 * (test "the dog bit the cat")
6 ("the dog bit the cat" "the dog bit the cat")
7 * 

You will probably not use &aux very often, but there are two other options for specifying function arguments: &optional and &key.

The following code example shows how to use optional function arguments. Note that optional arguments must occur after required arguments.

 1 * (defun test (a &optional b (c 123))
 2         (format t "a=~A b=~A c=~A~%" a b c))
 3 TEST
 4 * (test 1)
 5 a=1 b=NIL c=123
 6 NIL
 7 * (test 1 2)
 8 a=1 b=2 c=123
 9 NIL
10 * (test 1 2 3)
11 a=1 b=2 c=3
12 NIL
13 * (test 1 2 "Italian Greyhound")
14 a=1 b=2 c=Italian Greyhound
15 NIL
16 * 

In this example, the optional argument b was not given a default value so if unspecified it will default to nil. The optional argument c is given a default value of 123.

We have already seen the use of keyword arguments in built-in Lisp functions. Here is an example of how to specify key word arguments in your functions:

 1 * (defun test (a &key b c)
 2         (format t "a=~A b=~A c=~A~%" a b c))
 3 TEST
 4 * (test 1)
 5 a=1 b=NIL c=NIL
 6 NIL
 7 * (test 1 :c 3.14159)
 8 a=1 b=NIL c=3.14159
 9 NIL
10 * (test "cat" :b "dog")
11 a=cat b=dog c=NIL
12 NIL
13 * 

Using Lambda Forms

It is often useful to define unnamed functions. We can define an unnamed function using lambda; for example, let’s look at the example file src/lambda1.lisp. But first, we will introduce the Common Lisp function funcall that takes one or more arguments; the first argument is a function and any remaining arguments are passed to the function bound to the first argument. For example:

1 * (funcall 'print 'cat)
2 CAT 
3 CAT
4 * (funcall '+ 1 2)
5 3
6 * (funcall #'- 2 3)
7 -1
8 * 

In the first two calls to funcall here, we simply quote the function name that we want to call. In the third example, we use a better notation by quoting with #’. We use the #’ characters to quote a function name. Here is the example file src/lambda1.lisp:

1 (defun test ()
2   (let ((my-func
3           (lambda (x) (+ x 1))))
4     (funcall my-func 1)))

Here, we define a function using lambda and set the value of the local variable my-func to the unnamed function’s value. Here is output from the function test:

1 * (test)
2 2
3 
4 * 

The ability to use functions as data is surprisingly useful. For now, we will look at a simple example:

 1 * (defvar f1 #'(lambda (x) (+ x 1)))
 2 
 3 F1
 4 * (funcall f1 100)
 5 
 6 101
 7 * (funcall #'print 100)
 8 
 9 100 
10 100

Notice that the second call to function testfn prints “100” twice: the first time as a side effect of calling the function print and the second time as the returned value of testfn (the function print returns what it is printing as its value).

Using Recursion

Later, we will see how to use special Common Lisp macros for programming repetitive loops. In this section, we will use recursion for both coding simple loops and as an effective way to solve a variety of problems that can be expressed naturally using recursion.

As usual, the example programs for this section are found in the src directory. In the file src/recursion1.lisp, we see our first example of recursion:

1 ;; a simple loop using recursion
2 
3 (defun recursion1 (value)
4   (format t "entering recursion1(~A)~\%" value)
5   (if (< value 5)
6       (recursion1 (1+ value))))

This example is simple, but it is useful for discussing a few points. First, notice how the function recursion1 calls itself with an argument value of one greater than its own input argument only if the input argument “value” is less than 5. This test keeps the function from getting in an infinite loop. Here is some sample output:

 1 * (load "recursion1.lisp")
 2 ;; Loading file recursion1.lisp ...
 3 ;; Loading of file recursion1.lisp is finished.
 4 T
 5 * (recursion1 0)
 6 entering recursion1(0)
 7 entering recursion1(1)
 8 entering recursion1(2)
 9 entering recursion1(3)
10 entering recursion1(4)
11 entering recursion1(5)
12 NIL
13 * (recursion1 -3)
14 entering recursion1(-3)
15 entering recursion1(-2)
16 entering recursion1(-1)
17 entering recursion1(0)
18 entering recursion1(1)
19 entering recursion1(2)
20 entering recursion1(3)
21 entering recursion1(4)
22 entering recursion1(5)
23 NIL
24 * (recursion1 20)
25 entering recursion1(20)
26 NIL
27 * 

Why did the call on line 24 not loop via recursion? Because the input argument is not less than 5, no recursion occurs.

Closures

We have seen that functions can take other functions as arguments and return new functions as values. A function that references an outer lexically scoped variable is called a closure. The example file src/closure1.lisp contains a simple example:

 1 (let* ((fortunes
 2         '("You will become a great Lisp Programmer"
 3           "The force will not be with you"
 4           "Take time for meditation"))
 5        (len (length fortunes))
 6        (index 0))
 7   (defun fortune ()
 8     (let ((new-fortune (nth index fortunes)))
 9       (setq index (1+ index))
10       (if (>= index len) (setq index 0))
11       new-fortune)))

Here the function fortune is defined inside a let form. Because the local variable fortunes is referenced inside the function fortune, the variable fortunes exists after the let form is evaluated. It is important to understand that usually a local variable defined inside a let form “goes out of scope” and can no longer be referenced after the let form is evaluated.

However, in this example, there is no way to access the contents of the variable fortunes except by calling the function fortune. At a minimum, closures are a great way to hide variables. Here is some output from loading the src/closure1.lisp file and calling the function fortune several times:

 1 * (load "closure1.lisp")
 2 ;; Loading file closure1.lisp ...
 3 ;; Loading of file closure1.lisp is finished.
 4 T
 5 * (fortune)
 6 "You will become a great Lisp Programmer"
 7 * (fortune)
 8 "The force will not be with you"
 9 * (fortune)
10 "Take time for meditation"
11 * (fortune)
12 "You will become a great Lisp Programmer"
13 * 

Quicklisp

For several decades managing packages and libraries was a manual process when developing Lisp systems. I used to package the source code for specific versions of libraries as part of my Common Lisp projects. Early package management systems mk-defsystem and ASDF were very useful, but I did not totally give up my practice keeping third party library source code with my projects until Zach Beane created the Quicklisp package system. You will need to have Quicklisp installed for many of the examples later in this book so please take the time to install it right now as per the instructions on the Quicklisp web site.

Using Quicklisp to Find Packages

We will need the Common Lisp Hunchentoot library later in the Chapter on Network Programming so we will install it now using Quicklisp.

We already know the package name we want, but let’s start by using Quicklisp to search for all packages with “hunchentoot” in the package name:

 1 * (ql:system-apropos "hunchentoot")
 2 #<SYSTEM clack-handler-hunchentoot / clack-20131111-git / quicklisp 2013-11-11>
 3 #<SYSTEM hunchentoot / hunchentoot-1.2.21 / quicklisp 2013-11-11>
 4 #<SYSTEM hunchentoot-auth / hunchentoot-auth-20101107-git / quicklisp 2013-11-11>
 5 #<SYSTEM hunchentoot-cgi / hunchentoot-cgi-20121125-git / quicklisp 2013-11-11>
 6 #<SYSTEM hunchentoot-dev / hunchentoot-1.2.21 / quicklisp 2013-11-11>
 7 #<SYSTEM hunchentoot-single-signon / hunchentoot-single-signon-20131111-git / qu\
 8 icklisp 2013-11-11>
 9 #<SYSTEM hunchentoot-test / hunchentoot-1.2.21 / quicklisp 2013-11-11>
10 #<SYSTEM hunchentoot-vhost / hunchentoot-vhost-20110418-git / quicklisp 2013-11-\
11 11>

We want the base package seen in line 3 and we can install the base package as seen in the following example:

1 * (ql:quickload :hunchentoot)
2 To load "hunchentoot":
3   Load 1 ASDF system:
4     hunchentoot
5 ; Loading "hunchentoot"
6 .......
7 (:HUNCHENTOOT)

In line 1, I refer to the package name using a symbol :hunchentoot but using the string “hunchentoot” would have worked the same. The first time you ql:quickload a library you may see additional printout. In most of the rest of this book, when I install or use a package by calling the ql:quickload function I do not show the output from this function when in the repl listings.

Now, we can use the fantastically useful Common Lisp function apropos to see what was just installed:

 1 * (apropos "hunchentoot")
 2 
 3 HUNCHENTOOT::*CLOSE-HUNCHENTOOT-STREAM* (bound)
 4 HUNCHENTOOT:*HUNCHENTOOT-DEFAULT-EXTERNAL-FORMAT* (bound)
 5 HUNCHENTOOT::*HUNCHENTOOT-STREAM*
 6 HUNCHENTOOT:*HUNCHENTOOT-VERSION* (bound)
 7 HUNCHENTOOT:HUNCHENTOOT-CONDITION
 8 HUNCHENTOOT:HUNCHENTOOT-ERROR (fbound)
 9 HUNCHENTOOT::HUNCHENTOOT-OPERATION-NOT-IMPLEMENTED-OPERATION (fbound)
10 HUNCHENTOOT::HUNCHENTOOT-SIMPLE-ERROR
11 HUNCHENTOOT::HUNCHENTOOT-SIMPLE-WARNING
12 HUNCHENTOOT::HUNCHENTOOT-WARN (fbound)
13 HUNCHENTOOT:HUNCHENTOOT-WARNING
14 HUNCHENTOOT-ASD:*HUNCHENTOOT-VERSION* (bound)
15 HUNCHENTOOT-ASD::HUNCHENTOOT
16 :HUNCHENTOOT (bound)
17 :HUNCHENTOOT-ASD (bound)
18 :HUNCHENTOOT-DEV (bound)
19 :HUNCHENTOOT-NO-SSL (bound)
20 :HUNCHENTOOT-TEST (bound)
21 :HUNCHENTOOT-VERSION (bound)
22 * 

As long as you are thinking about the new tool Quicklisp that is now in your tool chest, you should install the rest of the packages and libraries that you will need for working through the rest of this book. I will show the statements needed to load more libraries without showing the output printed in the repl as each package is loaded:

1 (ql:quickload "clsql")
2 (ql:quickload "clsql-postgresql")
3 (ql:quickload "clsql-mysql")
4 (ql:quickload "clsql-sqlite3")
5 (ql:quickload :drakma)
6 (ql:quickload :hunchentoot)
7 (ql:quickload :cl-json)
8 (ql:quickload "clouchdb")  ;; for CouchDB access

You need to have the Postgres and MySQL client developer libraries installed on your system for the clsql-postgresql and clsql-mysql installations to work.

Using Quicklisp to Configure Emacs and Slime

I assume that you have Emacs installed on your system. In a repl you can setup the Slime package that allows Emacs to connect to a running Lisp environment:

(ql:quickload "quicklisp-slime-helper")

Pay attention to the output in the repl. On my system the output contained the following:

1 [package quicklisp-slime-helper]
2 slime-helper.el installed in "/Users/markw/quicklisp/slime-helper.el"
3 
4 To use, add this to your ~/.emacs:
5 
6   (load (expand-file-name "~/quicklisp/slime-helper.el"))
7   ;; Replace "sbcl" with the path to your implementation
8   (setq inferior-lisp-program "sbcl")

If you installed rlwrap and defined an alias for running SBCL, make sure you set the inferior lisp program to the absolute path of the SBCL executable; on my system I set the following in my .emacs file:

1   (setq inferior-lisp-program "/Users/markw/sbcl/sbcl")

I am not going to cover using Emacs and Slime: there are many good tutorials on the web you can read.

Defining Common Lisp Macros

We saw in the last chapter how the Lisp function eval could be used to evaluate arbitrary Lisp code stored in lists. Because eval is inefficient, a better way to generate Lisp code automatically is to define macro expressions that are expanded inline when they are used. In most Common Lisp systems, using eval requires the Lisp compiler to compile a form on-the-fly which is not very efficient. Some Lisp implementations use an interpreter for eval which is likely to be faster but might lead to obscure bugs if the interpreter and compiled code do not function identically.

Example Macro

The file src/macro1.lisp contains both a simple macro and a function that uses the macro. This macro example is a bit contrived since it could be just a function definition, but it does show the process of creating and using a macro. We are using the gensym function to define a new unique symbol to reference a temporary variable:

 1 ;; first simple macro example:
 2 
 3 (defmacro double-list (a-list)
 4   (let ((ret (gensym)))
 5     `(let ((,ret nil))
 6        (dolist (x ,a-list)
 7          (setq ,ret (append ,ret (list x x))))
 8        ,ret)))
 9 
10 ;; use the macro:
11 
12 (defun test (x)
13   (double-list x))

The backquote character seen at the beginning of line 5 is used to quote a list in a special way: nothing in the list is evaluated during macro expansion unless it is immediately preceded by a comma character. In this case, we specify ,a-list because we want the value of the macro’s argument a-list to be substituted into the specially quoted list. We will look at dolist in some detail in the next chapter but for now it is sufficient to understand that dolist is used to iterate through the top-level elements of a list, for example:

1 * (dolist (x '("the" "cat" "bit" "the" "rat"))
2        (print x))
3 "the" 
4 "cat" 
5 "bit" 
6 "the" 
7 "rat" 
8 NIL
9 * 

Returning to our macro example in the file src/macro1.lisp, we will try the function test that uses the macro double-list:

1 * (load "macro1.lisp")
2 ;; Loading file macro1.lisp ...
3 ;; Loading of file macro1.lisp is finished.
4 T
5 * (test '(1 2 3))
6 (1 1 2 2 3 3)
7 *

Using the Splicing Operator

Another similar example is in the file src/macro2.lisp:

 1 ;; another macro example that uses ,@:
 2 
 3 (defmacro double-args (&rest args)
 4   `(let ((ret nil))
 5     (dolist (x ,@args)
 6       (setq ret (append ret (list x x))))
 7     ret))
 8 
 9 ;; use the macro:
10 
11 (defun test (&rest x)
12   (double-args x))

Here, the splicing operator ,@ is used to substitute in the list args in the macro double-args.

Using macroexpand-1

The function macroexpand-1 is used to transform macros with arguments into new Lisp expressions. For example:

1 * (defmacro double (a-number)                       
2         (list '+ a-number a-number))
3 DOUBLE
4 * (macroexpand-1 '(double n))
5 (+ N N) ;
6 T
7 * 

Writing macros is an effective way to extend the Lisp language because you can control the code passed to the Common Lisp compiler. In both macro example files, when the function test was defined, the macro expansion is done before the compiler processes the code. We will see in the next chapter several useful macros included in Common Lisp.

We have only “scratched the surface” looking at macros; the interested reader is encouraged to search the web using, for example, “Common Lisp macros.”

Using Common Lisp Loop Macros

In this chapter, we will discuss several useful macros for performing iteration (we saw how to use recursion for iteration in Chapter 2):

  • dolist – a simple way to process the elements of a list
  • dotimes – a simple way to iterate with an integer valued loop variable
  • do – the most general looping macro
  • loop – a complex looping macro that I almost never use in my own code because it does not look “Lisp like.” I don’t use the loop macro in this book. Many programmers do like the loop macro so you are likely to see it when reading other people’s code.

dolist

We saw a quick example of dolist in the last chapter. The arguments of the dolist macro are:

   (dolist (a-variable a-list [optional-result-value])   ...body... )

Usually, the dolist macro returns nil as its value, but we can add a third optional argument which will be returned as the generated expression’s value; for example:

1 * (dolist (a '(1 2) 'done) (print a))
2 1 
3 2 
4 DONE
5 * (dolist (a '(1 2)) (print a))
6 1 
7 2 
8 NIL
9 * 

The first argument to the dolist macro is a local lexically scoped variable. Once the code generated by the dolist macro finishes executing, this variable is undefined.

dotimes

The dotimes macro is used when you need a loop with an integer loop index. The arguments of the dotimes macro are:

   (dotimes (an-index-variable max-index-plus-one [optional-result-value])
         ...body... )

Usually, the dotimes macro returns nil as its value, but we can add a third optional argument that will be returned as the generated expression’s value; for example:

1 * (dotimes (i 3 "all-done-with-test-dotimes-loop") (print i))
2 
3 0 
4 1 
5 2 
6 "all-done-with-test-dotimes-loop"
7 * 

As with the dolist macro, you will often use a let form inside a dotimes macro to declare additional temporary (lexical) variables.

do

The do macro is more general purpose than either dotimes or dolist but it is more complicated to use. Here is the general form for using the do looping macro:

  (do ((variable-1 variable-1-init-value variable-1-update-expression)
          (variable-2 variable-2-init-value variable-2-update-expression)
          .
          .
          (variable-N variable-N-init-value variable-N-update-expression))
        (loop-termination-test  loop-return-value)
        optional-variable-declarations
        expressions-to-be-executed-inside-the-loop)

There is a similar macro do* that is analogous to let* in that loop variable values can depend on the values or previously declared loop variable values.

As a simple example, here is a loop to print out the integers from 0 to 3. This example is in the file src/do1.lisp:

;; example do macro use

(do ((i 0 (1+ i)))
        ((> i 3) "value-of-do-loop")
  (print i))

In this example, we only declare one loop variable so we might as well as used the simpler dotimes macro.

Here we load the file src/do1.lisp:

1 * (load "do1.lisp")
2 ;; Loading file do1.lisp ...
3 0 
4 1 
5 2 
6 3 
7 ;; Loading of file do1.lisp is finished.
8 T
9 * 

You will notice that we do not see the return value of the do loop (i.e., the string “value-of-do-loop”) because the top-level form that we are evaluating is a call to the function load; we do see the return value of load printed. If we had manually typed this example loop in the Lisp listener, then you would see the final value value-of-do-loop printed.

Using the loop Special Form to Iterate Over Vectors or Arrays’’

We previousely used dolist to iterate over elements in lists. For efficiency we will often use vectors (one dimensinal arrays) and we can use loop to similarly handle vectors:

  (loop for td across testdata
     do
       (print td))))

where testdata is a one dimensional array (a vector) and inside the do block the local variable td is assigned to each element in the vector.

Common Lisp Package System

In the simple examples that we have seen so far, all newly created Lisp symbols have been placed in the default package. You can always check the current package by evaluating the expression package:

> *package*
#<PACKAGE COMMON-LISP-USER>
> 

As we will use in the following example, the package :cl is an alias for :common-lisp-user.

We will define a new package :my-new-package and two functions foo1 and foo2 inside the package. Externally to this package, assuming that it is loaded, we can access foo2 using my-new-package:foo2. foo1 is not exported so it can not be accessed this way. However, once again assuming this package is loaded, we can always start a symbol name with a package name and two colon characters if we want to use a symbol defined in another package so we can use my-new-package::foo1.

When I leave package :my-new-package in line 22 and return to package :cl, and try to access my-new-package:foo1 notice that an error is thrown.

On line 3 we define the alias :p1 for the packkage :my-new-package and we use this alias in line 44.

 1 * (defpackage "MY-NEW-PACKAGE"
 2     (:use :cl)
 3     (:nicknames "P1")
 4     (:export "FOO2"))
 5 
 6 #<PACKAGE "MY-NEW-PACKAGE">
 7 * (in-package my-new-package)
 8 
 9 #<PACKAGE "MY-NEW-PACKAGE">
10 * (defun foo1 () "foo1")
11 
12 FOO1
13 * (defun foo2 () "foo2")
14 
15 FOO2
16 * (foo1)
17 
18 "foo1"
19 * (foo2)
20 
21 "foo2"
22 * (in-package :cl)
23 
24 #<PACKAGE "COMMON-LISP">
25 * (my-new-package:foo2)
26 
27 "foo2"
28 * (my-new-package:foo1)
29 
30 debugger invoked on a SB-INT:SIMPLE-READER-PACKAGE-ERROR in thread
31 #<THREAD "main thread" RUNNING {1001F1ECE3}>:
32   The symbol "FOO1" is not external in the MY-NEW-PACKAGE package.
33 
34     Stream: #<SYNONYM-STREAM :SYMBOL SB-SYS:*STDIN* {100001C343}>
35 
36 Type HELP for debugger help, or (SB-EXT:EXIT) to exit from SBCL.
37 
38 restarts (invokable by number or by possibly-abbreviated name):
39   0: [CONTINUE] Use symbol anyway.
40   1: [ABORT   ] Exit debugger, returning to top level.
41 
42 * 1
43  
44 * (p1:foo2)
45 
46 "foo2"

Since we specified a nickname in the defpackage expression, Common Lisp uses the nickname (in this case P1 in calling function foo2 that is exported from package :my-new-package.

Near the end of the last example, we switched back to the default package COMMON-LISP-USER so we had to specify the package name for the function foo2.

When you are writing very large Common Lisp programs, it is useful to be able to break up the program into different modules and place each module and all its required data in different name spaces by creating new packages. Remember that all symbols, including variables, generated symbols, CLOS methods, functions, and macros are in some package.

When I use a package I usually place everything in the package in a single source file. I put a defpackage expression at the top of the file immediately followed by an in-package expression to switch to the new package. Note that whenever a new file is loaded into a Lisp environment, the current package is set back to the default package COMMON-LISP-USER.

Since the use of packages is a common source of problems for new users, you might want to “put off” using packages until your Common Lisp programs become large enough to make the use of packages effective.

Input and Output

We will see that the input and output of Lisp data is handled using streams. Streams are powerful abstractions that support common libraries of functions for writing to the terminal, to files, to sockets, and to strings.

In all cases, if an input or output function is called without specifying a stream, the default for input stream is *standard-input* and the default for output stream is *standard-output*. These defaults streams are connected to the Lisp listener that we discussed in Chapter 2.

The Lisp read and read-line Functions

The function read is used to read one Lisp expression. Function read stops reading after reading one expression and ignores new line characters. We will look at a simple example of reading a file test.dat using the example Lisp program in the file read-test-1.lisp. Both of these files, as usual, can be found in the directory src that came bundled with this web book. Start your Lisp program in the src directory. The contents of the file test.dat is:

1 1 2 3
2 4 "the cat bit the rat"
3         read with-open-file

In the function read-test-1, we use the macro with-open-file to read from a file. To write to a file (which we will do later), we can use the keyword arguments :direction :output. The first argument to the macro with-open-file is a symbol that is bound to a newly created input stream (or an output stream if we are writing a file); this symbol can then be used in calling any function that expects a stream argument.

Notice that we call the function read with three arguments: an input stream, a flag to indicate if an error should be thrown if there is an I/O error (e.g., reaching the end of a file), and the third argument is the value that function read should return if the end of the file (or stream) is reached. When calling read with these three arguments, either the next expression from the file test.dat will be returned, or the value nil will be returned when the end of the file is reached. If we do reach the end of the file, the local variable x will be assigned the value nil and the function return will break out of the dotimes loop. One big advantage of using the macro with-open-file over using the open function (which we will not cover) is that the file stream is automatically closed when leaving the code generated by the with-open-file macro. The contents of file read-test-1.lisp is:

(defun read-test-1 ()
  "read a maximum of 1000 expressions from the file 'test.dat'"
  (with-open-file
   (input-stream "test.dat" :direction :input)
   (dotimes (i 1000)
     (let ((x (read input-stream nil nil)))
       (if (null x) (return)) ;; break out of the 'dotimes' loop
       (format t "next expression in file: ~S~%" x)))))

Here is the output that you will see if you load the file read-test-1.lisp and execute the expression (read-test-1):

 1 * (load "read-test-1.lisp")
 2 ;; Loading file read-test-1.lisp ...
 3 ;; Loading of file read-test-1.lisp is finished.
 4 T
 5 * (read-test-1)
 6 next expression in file: 1
 7 next expression in file: 2
 8 next expression in file: 3
 9 next expression in file: 4
10 next expression in file: "the cat bit the rat"
11 NIL

Note: the string “the cat bit the rat” prints as a string (with quotes) because we used a ~S instead of a ~A in the format string in the call to function format.

In this last example, we passed the file name as a string to the macro with-open-file. This is not generally portable across all operating systems. Instead, we could have created a pathname object and passed that instead. The pathname function can take eight different keyword arguments, but we will use only the two most common in the example in the file read-test-2.lisp in the src directory. The following listing shows just the differences between this example and the last:

  (let ((a-path-name
          (make-pathname :directory "testdata"
                         :name "test.dat")))
    (with-open-file
     (input-stream a-path-name :direction :input)

Here, we are specifying that we should look for the for the file test.dat in the subdirectory testdata. Note: I almost never use pathnames. Instead, I specify files using a string and the character / as a directory delimiter. I find this to be portable for the Macintosh, Windows, and Linux operating systems using all Common Lisp implementations.

The file readline-test.lisp is identical to the file read-test-1.lisp except that we call function readline instead of the function read and we change the output format message to indicate that an entire line of text has been read

(defun readline-test ()
  "read a maximum of 1000 expressions from the file 'test.dat'"
  (with-open-file
   (input-stream "test.dat" :direction :input)
   (dotimes (i 1000)
     (let ((x (read-line input-stream nil nil)))
       (if (null x) (return)) ;; break out of the 'dotimes' loop
       (format t "next line in file: ~S~%" x)))))

When we execute the expression (readline-test), notice that the string contained in the second line of the input file has the quote characters escaped:

1 * (load "readline-test.lisp")
2 ;; Loading file readline-test.lisp ...
3 ;; Loading of file readline-test.lisp is finished.
4 T
5 * (readline-test)
6 next line in file: "1 2 3"
7 next line in file: "4 \"the cat bit the rat\""
8 NIL
9 *

We can also create an input stream from the contents of a string. The file read-from-string-test.lisp is very similar to the example file read-test-1.lisp except that we use the macro with-input-from-string (notice how I escaped the quote characters used inside the test string):

(defun read-from-string-test ()
  "read a maximum of 1000 expressions from a string"
  (let ((str "1 2 \"My parrot is named Brady.\" (11 22)"))
    (with-input-from-string
     (input-stream str)
     (dotimes (i 1000)
       (let ((x (read input-stream nil nil)))
         (if (null x) (return)) ;; break out of the 'dotimes' loop
         (format t "next expression in string: ~S~%" x))))))

We see the following output when we load the file read-from-string-test.lisp:

 1 * (load "read-from-string-test.lisp")
 2 ;; Loading file read-from-string-test.lisp ...
 3 ;; Loading of file read-from-string-test.lisp is finished.
 4 T
 5 * (read-from-string-test)
 6 next expression in string: 1
 7 next expression in string: 2
 8 next expression in string: "My parrot is named Brady."
 9 next expression in string: (11 22)
10 NIL
11 *

We have seen how the stream abstraction is useful for allowing the same operations on a variety of stream data. In the next section, we will see that this generality also applies to the Lisp printing functions.

Lisp Printing Functions

All of the printing functions that we will look at in this section take an optional last argument that is an output stream. The exception is the format function that can take a stream value as its first argument (or t to indicate *standard-output*, or a nil value to indicate that format should return a string value).

Here is an example of specifying the optional stream argument:

1 * (print "testing")
2 
3 "testing" 
4 "testing"
5 * (print "testing" *standard-output*)
6 
7 "testing" 
8 "testing"
9 *

The function print prints Lisp objects so that they can (usually) be read back using function read. The corresponding function princ is used to print for “human consumption”. For example:

1 * (print "testing")
2 
3 "testing" 
4 "testing"
5 * (princ "testing")
6 testing
7 "testing"
8 * 

Both print and princ return their first argument as their return value, which you see in the previous output. Notice that princ also does not print a new line character, so princ is often used with terpri (which also takes an optional stream argument).

We have also seen many examples in this web book of using the format function. Here is a different use of format, building a string by specifying the value nil for the first argument:

1 * (let ((l1 '(1 2))
2            (x 3.14159))
3        (format nil "~A~A" l1 x))
4 "(1 2)3.14159"
5 * 

We have not yet seen an example of writing to a file. Here, we will use the with-open-file macro with options to write a file and to delete any existing file with the same name:

(with-open-file (out-stream "test1.dat"
                   :direction :output
                   :if-exists :supersede)
       (print "the cat ran down the road" out-stream)
       (format out-stream "1 + 2 is: ~A~%" (+ 1 2))
       (princ "Stoking!!" out-stream)
       (terpri out-stream))

Here is the result of evaluating this expression (i.e., the contents of the newly created file test1.dat in the src directory):

1 % cat test1.dat 
2 
3 "the cat ran down the road" 1 + 2 is: 3
4 Stoking!!

Notice that print generates a new line character before printing its argument.

Plotting Data

We will use Zach Beane’s vecto library for plotting data with the results written to files. Ideally we would like to have interactive plotting capability but for the purposes of this book I need to support the combinations of all Common Lisp implementations on multiple operating systems. Interactive plotting libraries are usually implementation and OS dependent.

The examples here are all contained in the source file plotlib.lisp and this code will be used in later chapters.

When I work on my macOS laptop, I leave the output graphics file open in the Preview App and whenever I rerun a program producing graphics in the REPL, making the preview App window active refreshes the graphics display.

PNG file generated by running plotlib test
PNG file generated by running plotlib test

The following listing shows the file plotlib.lisp that is a simple wrapper for the vecto Common Lisp plotting library. Please note that I only implemented wrappers for vecto functionality that I need for later examples in this book, so the following code is not particularly general but should be easy enough for you to extend for the specific needs of your projects.

 1 ;; Misc. plotting examples using the vecto library
 2 
 3 (ql:quickload :vecto) ;; Zach Beane's plotting library
 4 (defpackage #:plotlib
 5   (:use #:cl #:vecto))
 6 
 7 (in-package #:plotlib)
 8 
 9 ;; the coordinate (0,0) is the lower left corner of the plotting area.
10 ;; Increasing the y coordinate is "up page" and increasing x is "to the right"
11 
12 ;; fills a rectangle with a gray-scale value
13 (defun plot-fill-rect (x y width height gscale) ; 0 < gscale < 1
14   (set-rgb-fill gscale gscale gscale)
15   (rectangle x y width height)
16   (fill-path))
17 
18 ;; plots a frame rectangle
19 (defun plot-frame-rect (x y width height)
20   (set-line-width 1)
21   (set-rgb-fill 1 1 1)
22   (rectangle x y width height)
23   (stroke))
24 
25 (defun plot-line(x1 y1 x2 y2)
26   (set-line-width 1)
27   (set-rgb-fill 0 0 0)
28   (move-to x1 y1)
29   (line-to x2 y2)
30   (stroke))
31 
32 (defun plot-string(x y str)
33   (let ((font (get-font "OpenSans-Regular.ttf")))
34     (set-font font 15)
35     (set-rgb-fill 0 0 0)
36     (draw-string x y str)))
37 
38 (defun plot-string-bold(x y str)
39   (let ((font (get-font "OpenSans-Bold.ttf")))
40     (set-font font 15)
41     (set-rgb-fill 0 0 0)
42     (draw-string x y str)))
43 
44 
45 (defun test-plotlib (file)
46   (with-canvas (:width 90 :height 90)
47     (plot-fill-rect 5 10 15 30 0.2) ; black
48     (plot-fill-rect 25 30 30 7 0.7) ; medium gray
49     (plot-frame-rect 10 50 30 7)
50     (plot-line 90 5 10 5)
51     (plot-string 10 65 "test 1 2 3")
52     (plot-string-bold 10 78 "Hello")
53     (save-png file)))
54 
55 ;;(test-plotlib "test-plotlib.png")

This plot library is used in later examples in the chapters on search, backpropagation neural networks and Hopfield neural networks. I prefer using implementation and operating specific ploting libraires for generating interactive plots but the advantage of writing plot data to a file using the vecto library is that the code is portable across operating systems and Common Lisp implementations.

Common Lisp Object System - CLOS

CLOS was the first ANSI standardized object oriented programming facility. While I do not use classes and objects as often in my Common Lisp programs as I do when using Java and Smalltalk, it is difficult to imagine a Common Lisp program of any size that did not define and use at least a few CLOS classes.

The example program for this chapter in the file src/HTMLstream.lisp. I used this CLOS class about ten years ago in a demo for my commercial natural language processing product to automatically generate demo web pages.

We are going to start our discussion of CLOS somewhat backwards by first looking at a short test function that uses the HTMLstream class. Once we see how to use this example CLOS class, we will introduce a small subset of CLOS by discussing in some detail the implementation of the HTMLstream class and finally, at the end of the chapter, see a few more CLOS programming techniques. This book only provides a brief introduction to CLOS; the interested reader is encouraged to do a web search for “CLOS tutorial”.

The macros and functions defined to implement CLOS are a standard part of Common Lisp. Common Lisp supports generic functions, that is, different functions with the same name that are distinguished by different argument types.

Example of Using a CLOS Class

The file src/HTMLstream.lisp contains a short test program at the end of the file:

1 (defun test (&aux x)
2     (setq x (make-instance 'HTMLstream))
3     (set-header x "test page")
4     (add-element x "test text - this could be any element")
5     (add-table
6          x
7          '(("<b>Key phrase</b>" "<b>Ranking value</b>")
8            ("this is a test" 3.3)))
9     (get-html-string x))

The generic function make-instance takes the following arguments:

1     make-instance class-name &rest initial-arguments &key ...

There are four generic functions used in the function test:

  • set-header - required to initialize class and also defines the page title
  • add-element - used to insert a string that defines any type of HTML element
  • add-table - takes a list of lists and uses the list data to construct an HTML table
  • get-html-string - closes the stream and returns all generated HTML data as a string

The first thing to notice in the function test is that the first argument for calling each of these generic functions is an instance of the class HTMLstream. You are free to also define a function, for example, add-element that does not take an instance of the class HTMLstream as the first function argument and calls to add-element will be routed correctly to the correct function definition.

We will see that the macro defmethod acts similarly to defun except that it also allows us to define many methods (i.e., functions for a class) with the same function name that are differentiated by different argument types and possibly different numbers of arguments.

Implementation of the HTMLstream Class

The class HTMLstream is very simple and will serve as a reasonable introduction to CLOS programming. Later we will see more complicated class examples that use multiple inheritance. Still, this is a good example because the code is simple and the author uses this class frequently (some proof that it is useful!). The code fragments listed in this section are all contained in the file src/HTMLstream.lisp. We start defining a new class using the macro defclass that takes the following arguments:

1     defclass class-name list-of-super-classes
2              list-of-slot-specifications class-specifications

The class definition for HTMLstream is fairly simple:

1 (defclass HTMLstream ()
2   ((out :accessor out))
3   (:documentation "Provide HTML generation services"))

Here, the class name is HTMLstream, the list of super classes is an empty list (), the list of slot specifications contains only one slot specification for the slot out and there is only one class specification: a documentation string. Most CLOS classes inherit from at least one super class but we will wait until the next section to see examples of inheritance. There is only one slot (or instance variable) and we define an accessor variable with the same name as the slot name. This is a personal preference of mine to name read/write accessor variables with the same name as the slot.

The method set-header initializes the string output stream used internally by an instance of this class. This method uses convenience macro with-accessors that binds a local set of local variable to one or more class slot accessors. We will list the entire method then discuss it:

1 (defmethod set-header ((ho HTMLstream) title)
2   (with-accessors
3       ((out out))
4       ho
5     (setf out (make-string-output-stream))
6     (princ "<HTML><head><title>" out)
7     (princ title out)
8     (princ "</title></head><BODY>" out)
9     (terpri out)))

The first interesting thing to notice about the defmethod is the argument list: there are two arguments ho and title but we are constraining the argument ho to be either a member of the class HTMLstream or a subclass of HTMLstream. Now, it makes sense that since we are passing an instance of the class HTMLstream to this generic function (or method – I use the terms “generic function” and “method” interchangeably) that we would want access to the slot defined for this class. The convenience macro with-accessors is exactly what we need to get read and write access to the slot inside a generic function (or method) for this class. In the term ((out out)), the first out is local variable bound to the value of the slot named out for this instance ho of class HTMLstream. Inside the with-accessors macro, we can now use setf to set the slot value to a new string output stream. Note: we have not covered the Common Lisp type string-output-stream yet in this web book, but we will explain its use on the next page.

By the time a call to the method set-header (with arguments of an HTMLstream instance and a string title) finishes, the instance has its slot set to a new string-output-stream and HTML header information is written to the newly created string output stream. Note: this string output stream is now available for use by any class methods called after set-header.

There are several methods defined in the file src/HTMLstream.lisp, but we will look at just four of them: add-H1, add-element, add-table, and get-html-string. The remaining methods are very similar to add-H1 and the reader can read the code in the source file.

As in the method set-header, the method add-H1 uses the macro with-accessors to access the stream output stream slot as a local variable out. In add-H1 we use the function princ that we discussed in Chapter on Input and Output to write HTML text to the string output stream:

1 (defmethod add-H1 ((ho HTMLstream) some-text)
2   (with-accessors
3    ((out out))
4    ho
5    (princ "<H1>" out)
6    (princ some-text out)
7    (princ "</H1>" out)
8    (terpri out)))

The method add-element is very similar to add-H1 except the string passed as the second argument element is written directly to the stream output stream slot:

1 (defmethod add-element ((ho HTMLstream) element)
2   (with-accessors
3       ((out out))
4       ho
5     (princ element out)
6     (terpri out)))

The method add-table converts a list of lists into an HTML table. The Common Lisp function princ-to-string is a useful utility function for writing the value of any variable to a string. The functions string-left-trim and string-right-trim are string utility functions that take two arguments: a list of characters and a string and respectively remove these characters from either the left or right side of a string. Note: another similar function that takes the same arguments is string-trim that removes characters from both the front (left) and end (right) of a string. All three of these functions do not modify the second string argument; they return a new string value. Here is the definition of the add-table method:

 1 (defmethod add-table ((ho HTMLstream) table-data)
 2   (with-accessors
 3       ((out out))
 4       ho
 5     (princ "<TABLE BORDER=\"1\" WIDTH=\"100\%\">" out)
 6     (dolist (d table-data)
 7       (terpri out)
 8       (princ "  <TR>" out)
 9       (terpri out)
10       (dolist (w d)
11         (princ "    <TD>" out)
12         (let ((str (princ-to-string w)))
13           (setq str (string-left-trim '(#\() str))
14           (setq str (string-right-trim '(#\)) str))
15           (princ str out))
16         (princ "</TD>" out)
17         (terpri out))
18       (princ "  </TR>" out)
19       (terpri out))
20     (princ "</TABLE>" out)
21     (terpri out)))

The method get-html-string gets the string stored in the string output stream slot by using the function get-output-stream-string:

1 (defmethod get-html-string ((ho HTMLstream))
2   (with-accessors
3       ((out out))
4       ho
5   (princ "</BODY></HTML>" out)
6   (terpri out)
7   (get-output-stream-string out)))

CLOS is a rich framework for object oriented programming, providing a superset of features found in languages like Java, Ruby, and Smalltalk. I have barely scratched the surface in this short CLOS example for generating HTML. Later in the book, whenever you see calls to make-instance that lets you know we are using CLOS even if I don’t specifically mention CLOS in the examples.

We represent search space as a graph: nodes and links between the nodes. The following figure shows the simple graph that we use as an example, finding a route from node n1 to node n11:

Plot of best route using the plotlib utilities
Plot of best route using the plotlib utilities

The following example code uses a heuristic for determining which node to try first from any specific location: move to the node that is closest spatially to the goal node. We see that this heuristic will not always work to produce the most efficient search but we will still get to the goal node. As an example in which the heuristic does not work, consider when we start at node n1 in the lower left corner of the figure. The search algorithm can add nodes n2 and n4 to the nodes to search list and will search using node n4 first since n4 is closer to the goal node n11 than node n2. In this case, the search will eventually need to back up trying the path n1 to n2. Despite this example of the heuristic not working to decrease search time, in general, for large search spaces (i.e., graphs with many nodes and edges) it can dramatically decrease search time.

The main function Asearch** starting in line 5 extends to line 151 because all search utility functions are nested (lexically scoped) inside the mani function. The actual code for the main function **Asearch is in lines 150 and 151.

The data representing nodes in this implementation is globally scoped (see the definitions on lines 155-165 in the “throw away test code” near the bottom of the file) and we set the property path-list to store the nodes directy connected to each node (set in function init-path-list in lines 36-52). I originally wrote this code in 1990 which explains it non-functional style using globally scoped node variables.

  1 ;; Perform a heuristic A* search between the start and goal nodes:
  2 ;;
  3 ;; Copyright 1990, 2017 by Mark Watson
  4 
  5 (defun A*search (nodes paths start goal &aux possible-paths best)
  6 
  7   (defun Y-coord (x) (truncate (cadr x)))
  8   (defun X-coord (x) (truncate (car x)))
  9 
 10   (defun dist-between-points (point1 point2)
 11     (let ((x-dif (- (X-coord point2) (X-coord point1)))
 12           (y-dif (- (Y-coord point2) (Y-coord point1))))
 13       (sqrt (+ (* x-dif x-dif)  (* y-dif y-dif)))))
 14 
 15   (setq possible-paths
 16         (list
 17          (list
 18           (dist-between-points
 19            (eval start)
 20            (eval goal))
 21           0
 22           (list start))))
 23 
 24   (defun init-network ()
 25     (setq paths (init-lengths paths))
 26     (init-path-list nodes paths))
 27 
 28   (defun init-lengths (pathlist)
 29     (let (new-path-list pathlength path-with-length)
 30       (dolist (path pathlist)
 31         (setq pathlength (slow-path-length path))
 32         (setq path-with-length (append path (list pathlength)))
 33         (setq new-path-list (cons path-with-length new-path-list)))
 34       new-path-list))
 35 
 36   (defun init-path-list (nodes paths)
 37     (dolist (node nodes)
 38       (setf
 39        (get node 'path-list)
 40        ;; let returns all paths connected to node:
 41        (let (path-list)
 42          (dolist (path paths)
 43            (if (equal node (start-node-name path))
 44                (setq path-list
 45                      (cons (list (end-node-name path)
 46                                  (path-length path))
 47                            path-list))
 48                (if (equal node (end-node-name path))
 49                    (setq path-list (cons (list (start-node-name path)
 50                                                (path-length path))
 51                                          path-list)))))
 52          path-list ))))
 53 
 54   (defun slow-path-length (path)
 55     (dist-between-points (start-node path) (end-node path)))
 56 
 57   (defun path-length (x) (caddr x))
 58 
 59   (defun start-node (path) (eval (car path)))
 60   (defun end-node (path) (eval (cadr path)))
 61   (defun start-node-name (x) (car x))
 62   (defun end-node-name (x) (cadr x))
 63   (defun first-on-path (x) (caddr x))
 64   (defun goal-node (x) (car x))
 65   (defun distance-to-that-node (x) (cadr x))
 66 
 67   (defun enumerate-children (node goal)
 68     (let* ((start-to-lead-node-dist (cadr node)) ;; distance already calculated
 69            (path (caddr node))
 70            (lead-node (car path)))
 71       (if (get-stored-path lead-node goal)
 72           (consider-best-path lead-node goal path start-to-lead-node-dist)
 73           (consider-all-nodes lead-node goal path start-to-lead-node-dist))))
 74 
 75   (defun consider-best-path (lead-node goal path distance-to-here)
 76     (let* (
 77            (first-node (get-first-node-in-path lead-node goal))
 78            (dist-to-first (+ distance-to-here
 79                              (get-stored-dist lead-node first-node)))
 80            (total-estimate (+ distance-to-here
 81                               (get-stored-dist lead-node goal)))
 82            (new-path (cons first-node path)))
 83       (list (list total-estimate dist-to-first new-path))))
 84 
 85   (defun get-stored-path (start goal)
 86     (if (equal start goal)
 87         (list start 0)
 88         (assoc goal (get start 'path-list))))
 89 
 90   (defun node-not-in-path (node path)
 91     (if (null path)
 92         t
 93         (if (equal node (car path))
 94             nil
 95             (node-not-in-path node (cdr path)))))
 96 
 97   (defun consider-all-nodes (lead-node goal path start-to-lead-node-dist)
 98     (let (dist-to-first total-estimate new-path new-nodes)
 99       (dolist (node (collect-linked-nodes lead-node))
100         (if (node-not-in-path node path)
101             (let ()
102               (setq dist-to-first (+ start-to-lead-node-dist
103                                      (get-stored-dist lead-node node)))
104               (setq total-estimate (+ dist-to-first
105                                       (dist-between-points
106                                        (eval node)
107                                        (eval  goal))))
108               (setq new-path (cons node path))
109               (setq new-nodes (cons (list total-estimate
110                                           dist-to-first
111                                           new-path)
112                                     new-nodes)))))
113       new-nodes))
114 
115   (defun collect-linked-nodes (node)
116     (let (links)
117       (dolist (link (get node 'path-list))
118         (if (null (first-on-path link))
119             (setq links (cons (goal-node link) links))))
120       links))
121 
122   (defun get-stored-dist (node1 node2)
123     (distance-to-that-node (get-stored-path node1 node2)))
124 
125   (defun collect-ascending-search-list-order (a l)
126     (if (null l)
127         (list a)
128         (if (< (car a) (caar l))
129             (cons a l)
130             (cons (car l) (Collect-ascending-search-list-order a (cdr l))))))
131 
132   (defun get-first-node-in-path (start goal)
133     (let (first-node)
134       (setq first-node  (first-on-path (get-stored-path start goal)))
135       (if first-node first-node goal)))
136 
137   (defun a*-helper ()
138     (if possible-paths
139         (let ()
140           (setq best (car possible-paths))
141           (setq possible-paths (cdr possible-paths))
142           (if (equal (first (caddr best)) goal)
143               best
144               (let ()
145                 (dolist (child (enumerate-children best goal))
146                   (setq possible-paths
147                         (collect-ascending-search-list-order
148                          child possible-paths)))
149                 (a*-helper))))))
150   (init-network)
151   (reverse (caddr (a*-helper))))
152 
153 ;;      Throw away test code:
154 
155 (defvar n1 '(30 201))
156 (defvar  n2 '(25 140))
157 (defvar  n3 '(55 30))
158 (defvar  n4 '(105 190))
159 (defvar  n5 '(95 110))
160 (defvar  n6 '(140 22))
161 (defvar  n7 '(160 150))
162 (defvar  n8 '(170 202))
163 (defvar  n9 '(189 130))
164 (defvar  n10 '(200 55))
165 (defvar  n11 '(205 201))
166 
167 (print (A*search
168         '(n1 n2 n3 n4 n5 n6 n7 n8 n9 n10 n11) ;; nodes
169         '((n1 n2) (n2 n3) (n3 n5) (n3 n6) (n6 n10) ;; paths
170           (n9 n10) (n7 n9) (n1 n4) (n4 n2) (n5 n8)
171           (n8 n4) (n7 n11))
172         'n1 'n11)) ;; starting and goal nodes

The following example in the repl shows the calculation of the path that we saw in the figure of the graph search space.

1 $ sbcl
2 * (load "astar_search.lisp")
3 
4 (N1 N2 N3 N6 N10 N9 N7 N11) 
5 T
6 * 

There are many types of search: breadth first as we used here, depth first, with heuristics to optimize search dependent on the type of search space.

Network Programming

Distributed computing is pervasive: you need to look no further than the World Wide Web, Internet chat, etc. Of course, as a Lisp programmer, you will want to do at least some of your network programming in Lisp! The previous editions of this book provided low level socket network programming examples. I decided that for this new edition, I would remove those examples and instead encourage you to “move further up the food chain” and work at a higher level of abstraction that makes sense for the projects you will likely be developing. Starting in the 1980s, a lot of my work entailed low level socket programming for distributed networked applications. As I write this, it is 2013, and there are better ways to structure distributed applications.

Specifically, since many of the examples later in this book fetch information from the web and linked data sources, we will start be learning how to use Edi Weitz’s Drakma HTTP client library. In order to have a complete client server example we will also look briefly at Edi Weitz’s Hunchentoot web server that uses JSON as a data serialization format. I used to use XML for data serialization but JSON has many advantages: easier for a human to read and it plays nicely with Javascript code and some data stores like Postgres (new in versions 9.x), MongoDB, and CouchDB that support JSON as a native data format.

The code snippets in the first two sections of this chapter are derived from examples in the Drackma and Hunchentoot documentation.

An introduction to Drakma

Edi Weitz’s Drakma library supports fetching data via HTTP requests. As you can see in the Drakma documentation, you can use this library for authenticated HTTP requests (i.e., allow you to access web sites that require a login), support HTTP GET and PUT operations, and deal with cookies. The top level API that we will use is drakma:http-request that returns multiple values. In the following example, I want only the first three values, and ignore the others like the original URI that was fetched and an IO stream object. We use the built-in Common Lisp macro multiple-value-setq:

1 * (ql:quickload :drakma)
2 * (multiple-value-setq
3     (data http-response-code headers)
4     (drakma:http-request "http://markwatson.com"))

I manually formatted the last statement I entered in the last repl listing and I will continue to manually edit the repl listings in the rest of this book to make them more easily readable.

The following shows some of the data bound to the variables data, http-response-code, and headers:

1 * data
2 
3 "<!DOCTYPE html>
4 <html>
5   <head>
6 	<title>Mark Watson: Consultant and Author</title>

The value of http-response-code is 200 which means that there were no errors:

1 * http-response-code
2 
3 200

The HTTP response headers will be useful in many applications; for fetching the home page of my web site the headers are:

 1 * headers
 2 
 3 ((:SERVER . "nginx/1.1.19")
 4  (:DATE . "Fri, 05 Jul 2013 15:18:27 GMT")
 5  (:CONTENT-TYPE . "text/html; charset=utf-8")
 6  (:TRANSFER-ENCODING . "chunked")
 7  (:CONNECTION . "close")
 8  (:SET-COOKIE
 9    .
10    "ring-session=cec5d7ba-e4da-4bf4-b05e-aff670e0dd10;Path=/"))

We will use Drakma later in this book for several examples. In the next section we will write a web app using Hunchentoot and test it with a Drakma client.

An introduction to Hunchentoot

Edi Weitz’s Hunchentoot project is a flexible library for writing web applications and web services. We will also use Edi’s CL-WHO library in this section for generating HTML from Lisp code. Hunchentoot will be installed the first time you quick load it in the example code for this section:

1 (ql:quickload "hunchentoot")

I will use only easy handler framework in the Hunchentoot examples in this section. I leave it to you to read the documentation on using custom acceptors after you experiment with the examples in this section.

The following code will work for both multi-threading installations of SBCL and single thread installations (e.g., some default installations of SBCL on OS X):

 1 (ql:quickload :hunchentoot)
 2 (ql:quickload :cl-who)
 3 
 4 (in-package :cl-user)
 5 (defpackage hdemo
 6   (:use :cl
 7         :cl-who
 8         :hunchentoot))
 9 (in-package :hdemo)
10 
11 (defvar *h* (make-instance 'easy-acceptor :port 3000))
12 
13 ;; define a handler with the arbitrary name my-greetings:
14 
15 (define-easy-handler (my-greetings :uri "/hello") (name)
16   (setf (hunchentoot:content-type*) "text/html")
17   (with-html-output-to-string (*standard-output* nil :prologue t)
18     (:html
19      (:head (:title "hunchentoot test"))
20      (:body
21       (:h1 "hunchentoot form demo")
22       (:form
23        :method :post
24        (:input :type :text
25 	       :name "name"
26 	       :value name)
27        (:input :type :submit :value "Submit your name"))
28       (:p "Hello " (str name))))))
29 
30 (hunchentoot:start *h*)

In lines 5 through 9 we create an use a new package that includes support for generating HTML in Lisp code (CL-WHO) and the Hunchentoot library). On line 11 we create an instance of an easy acceptor on port 3000 that provides useful default behaviors for providing HTTP services.

The Hunchentoot macro define-easy-handler is used in lines 15 through 28 to define an HTTP request handler and add it to the easy acceptor instance. The first argument, my-greetings in this example, is an arbitrary name and the keyword :uri argument provides a URL pattern that the easy acceptor server object uses to route requests to this handler. For example, when you run this example on your computer, this URL routing pattern would handle requests like:

1 http://localhost:3000/hello

In lines 17 through 28 we are using the CL-WHO library to generate HTML for a web page. As you might guess, :html generates the outer <html></html> tags for a web page. Line 19 would generate HTML like:

1   <head>
2 	<title>hunchentoot test</title>
3   </head>

Lines 22 through 27 generate an HTML input form and line 28 displays any value generated when the user entered text in the input filed and clicked the submit button. Notice the definition of the argument name in line 1 in the definition of the easy handler. If the argument name is not defined, the nil value will be displayed in line 28 as an empty string.

You should run this example and access the generated web page in a web browser, and enter text, submit, etc. You can also fetch the generated page HTML using the Drakma library that we saw in the last section. Here is a code snippet using the Drakma client library to access this last example:

 1 * (drakma:http-request "http://127.0.0.1:3000/hello?name=Mark")
 2 
 3 "Hello Mark"
 4 200
 5 ((:CONTENT-LENGTH . "10")
 6  (:DATE . "Fri, 05 Jul 2013 15:57:22 GMT")
 7  (:SERVER . "Hunchentoot 1.2.18")
 8  (:CONNECTION . "Close")
 9  (:CONTENT-TYPE . "text/plain; charset=utf-8"))
10 #<PURI:URI http://127.0.0.1:3000/hello?name=Mark>
11 #<FLEXI-STREAMS:FLEXI-IO-STREAM {10095654A3}>
12 T
13 "OK"

We will use both Drackma and Hunchentoot in the next section.

Complete REST Client Server Example Using JSON for Data Serialization

A reasonable way to build modern distributed systems is to write REST web services that serve JSON data to client applications. These client applications might be rich web apps written in Javascript, other web services, and applications running on smartphones that fetch and save data to a remote web service.

We will use the cl-json Quicklisp package to encode Lisp data into a string representing JSON encoded data. Here is a quick example:

1 * (ql:quickload :cl-json)
2 * (defvar y (list (list '(cat . "the cat ran") '(dog . 101)) 1 2 3 4 5))
3 
4 Y
5 * y
6 
7 (((CAT . "the cat ran") (DOG . 101)) 1 2 3 4 5)
8 * (json:encode-json-to-string y)
9 "[{\"cat\":\"the cat ran\",\"dog\":101},1,2,3,4,5]"

The following list shows the contents of the file src/web-hunchentoot-json.lisp:

 1 (ql:quickload :hunchentoot)
 2 (ql:quickload :cl-json)
 3 
 4 (defvar *h* (make-instance 'hunchentoot:easy-acceptor :port 3000))
 5 
 6 ;; define a handler with the arbitrary name my-greetings:
 7 
 8 (hunchentoot:define-easy-handler (animal :uri "/animal") (name)
 9   (print name)
10   (setf (hunchentoot:content-type*) "text/plain")
11   (cond
12     ((string-equal name "cat")
13      (json:encode-json-to-string
14        (list
15         (list
16          '(average_weight . 10)
17          '(friendly . nil))
18         "A cat can live indoors or outdoors.")))
19     ((string-equal name "dog")
20      (json:encode-json-to-string
21        (list
22         (list
23          '(average_weight . 40)
24          '(friendly . t))
25         "A dog is a loyal creature, much valued by humans.")))
26     (t
27      (json:encode-json-to-string
28        (list
29         ()
30         "unknown type of animal")))))
31 
32 (hunchentoot:start *h*)

This example is very similar to the web application example in the last section. The difference is that this application is not intended to be viewed on a web page because it returns JSON data as HTTP responses. The easy handler definition on line 8 specifies a handler argument name. In lines 12 and 19 we check to see if the value of the argument name is “cat” or “dog” and if it is, we return the appropriate JSON example data for those animals. If there is no match, the default cond clause starting on line 26 returns a warning string as a JSON encoded string.

While running this test service, in one repl, you can ue the Drakma library in another repl to test it (not all output is shown in the next listing):

 1 * (ql:quickload :drakma)
 2 * (drakma:http-request "http://127.0.0.1:3000/animal?name=dog")
 3 
 4 "[{\"average_weight\":40,
 5    \"friendly\":true},
 6    \"A dog is a loyal creature, much valued by humans.\"]"
 7 200
 8 * (drakma:http-request "http://127.0.0.1:3000/animal?name=cat")
 9 
10 "[{\"average_weight\":10,
11    \"friendly\":null},
12    \"A cat can live indoors or outdoors.\"]"
13 200

You can use the cl-json library to decode a string containing JSON data to Lisp data:

 1 * (ql:quickload :cl-json)
 2 To load "cl-json":
 3   Load 1 ASDF system:
 4     cl-json
 5 ; Loading "cl-json"
 6 .
 7 (:CL-JSON)
 8 * (cl-json:decode-json-from-string
 9     (drakma:http-request "http://127.0.0.1:3000/animal?name=dog"))
10 
11 (((:AVERAGE--WEIGHT . 40) (:FRIENDLY . T))
12  "A dog is a loyal creature, much valued by humans.")

For most of my work, REST web services are “read-only” in the sense that clients don’t modify state on the server. However, there are use cases where a client application might want to; for example, letting clients add new animals to the last example.

 1 (defparameter *animal-hash* (make-hash-table))
 2 
 3 ;; handle HTTP POST requests:
 4 (hunchentoot:define-easy-handler (some-handler :uri "/add") (json-data)
 5   (setf (hunchentoot:content-type*) "text/plain")
 6   (let* ((data-string (hunchentoot:raw-post-data :force-text t))
 7          (data (cl-json:decode-json-from-string json-data))
 8          ;; assume that the name of the animal is a hashed value:
 9          (animal-name (gethash "name" data)))
10      (setf (gethash animal-name *animal-hash*) data))
11   "OK")

In line 4 we are defining an additional easy handler with a handler argument json-data. This data is assumed to be a string encoding of JSON data which is decoded into Lisp data in lines 6 and 7. We save the data to the global variable animal-hash.

In this example, we are storing data sent from a client in an in-memory hash table. In a real application new data might be stored in a database.

Accessing Relational Databases

There are good options for accessing relational databases from Common Lisp. Personally I almost always use Postgres and in the past I used either native foreign client libraries or the socket interface to Postgres. Recently, I decided to switch to CLSQL which provides a common interface for accessing Postgres, MySQL, SQLite, and Oracle databases. There are also several recent forks of CLSQL on github. We will use CLSQL in examples in this book. Hopefully while reading the Chapter on Quicklisp you installed CLSQL and the back end for one or more databases that you use for your projects. If you have not installed CLSQL yet, then please install it now:

(ql:quickload "clsql")

You also need to install one or more CLSQL backends, depending on which relational databases you use:

(ql:quickload "clsql-postgresql")
(ql:quickload "clsql-mysql")
(ql:quickload "clsql-sqlite3")

While I often prefer hand crafting SQL queries, there seems to be a general movement in software development towards the data mapper or active record design patterns. CLSQL provides Object Relational Mapping (ORM) functionality to CLOS.

You will need to create a new database news in order to follow along with the examples in this chapter and later in this book. I will use Postgres for examples in this chapter and use the following to create a new database (my account is “markw” and the following assumes that I have Postgres configured to not require a password for this account when accessing the database from “localhost”):

1 ->  ~  psql
2 psql (9.1.4)
3 Type "help" for help.
4 markw=# create database news;
5 CREATE DATABASE

We will use three example programs that you can find in the src directory in the book repository on github:

  • clsql_create_news_schema.lisp to create table “articles” in database “news”
  • clsql_write_to_news.lisp to write test data to table “articles”
  • clsql_read_from_news.lisp

The following listing shows the file src/clsql_create_news_schema.lisp:

 1 (ql:quickload :clsql)
 2 (ql:quickload :clsql-postgresql)
 3 
 4 ;; Postgres connection specification:
 5 ;;    (host db user password &optional port options tty).
 6 ;; The first argument to **clsql:connect** is a connection
 7 ;; specification list:
 8 
 9 (clsql:connect '("localhost" "news" "markw" nil)
10                :database-type :postgresql)
11 
12 (clsql:def-view-class articles ()
13   ((id
14     :db-kind :key
15     :db-constraints :not-null
16     :type integer
17     :initarg :id)
18    (uri
19     :accessor uri
20     :type (string 60)
21     :initarg :uri)
22    (title
23     :accessor title
24     :type (string 90)
25     :initarg :title)
26    (text
27     :accessor text
28     :type (string 500)
29     :nulls-ok t
30     :initarg :text)))
31 
32 (defun create-articles-table ()
33   (clsql:create-view-from-class 'articles))

In this repl listing, we create the database table “articles” using the function create-articles-table that we just defined:

1 ->  src git:(master) sbcl
2 (running SBCL from: /Users/markw/sbcl)
3 * (load "clsql_create_news_schema.lisp")
4 * (create-articles-table)
5 NOTICE:  CREATE TABLE / PRIMARY KEY will create implicit index
6          "article_pk" for table "articles"
7 T
8 *

The following listing shows the file src/clsql_write_to_news.lisp:

 1 (ql:quickload :clsql)
 2 (ql:quickload :clsql-postgresql)
 3 
 4 ;; Open connection to database and create CLOS class and database view
 5 ;; for table 'articles':
 6 (load "clsql_create_news_schema.lisp")
 7 
 8 (defvar *a1*
 9   (make-instance
10     'article
11     :uri "http://test.com"
12     :title "Trout Season is Open on Oak Creek"
13     :text "State Fish and Game announced the opening of trout season"))
14 
15 (clsql:update-records-from-instance *a1*)
16 ;; modify a slot value and update database:
17 (setf (slot-value *a1* 'title) "Trout season is open on Oak Creek!!!")
18 (clsql:update-records-from-instance *a1*)
19 ;; warning: the last statement changes the "id" column in the table

You should load the file clsql_write_to_news.lisp one time in a repl to create the test data. The following listing shows file clsql_read_from_news.lisp:

 1 (ql:quickload :clsql)
 2 (ql:quickload :clsql-postgresql)
 3 
 4 ;; Open connection to database and create CLOS class and database view
 5 ;; for table 'articles':
 6 (load "clsql_create_news_schema.lisp")
 7 
 8 (defun pp-article (article)
 9   (format t
10     "~%URI: ~S ~%Title: ~S ~%Text: ~S ~%"
11     (slot-value article 'uri)
12     (slot-value article 'title)
13     (slot-value article 'text)))
14 
15 (dolist (a (clsql:select 'article))
16   (pp-article (car a)))

Loading the file clsql_read_from_news.lisp produces the following output:

1 URI: "http://test.com" 
2 Title: "Trout season is open on Oak Creek!!!" 
3 Text: "State Fish and Game announced the opening of trout season"
4 
5 URI: "http://example.com" 
6 Title: "Longest day of year" 
7 Text: "The summer solstice is on Friday."

You can also embed SQL where clauses in queries:

(dolist (a (clsql:select 'article :where "title like '%season%'"))
  (pp-article (car a)))

which produces this output:

1 URI: "http://test.com" 
2 Title: "Trout season is open on Oak Creek!!!" 
3 Text: "State Fish and Game announced the opening of
4        trout season" 

In this example, I am using a SQL like expression to perform partial text matching.

Using MongoDB, CouchDB, and Solr NoSQL Data Stores

Non-relational data stores are commonly used for applications that don’t need either full relational algebra or must scale.

Brewer’s CAP theorem states that a distributed data storage system comprised of multiple nodes can be robust to two of three of the following guarantees: all nodes always have a Consistent view of the state of data, general Availablity of data if not all nodes are functioning, and Partition tolerance so clients can still communicate with the data storage system when parts of the system are unavailable because of network failures. The basic idea is that different applications have different requirements and sometimes it makes sense to reduce system cost or improve scalability by easing back on one of these requirements.

A good example is that some applications may not need transactions (the first guarantee) because it is not important if clients sometimes get data that is a few seconds out of date.

MongoDB allows you to choose consistency vs. availability vs. efficiency.

I cover the Solr indexing and search service (based on Lucene) both because a Solr indexed document store is a type of NoSQL data store and also because I believe that you will find Solr very useful for building systems, if you don’t already use it.

We will design the examples in this chapter so that they can be reused in the last chapter in this book on Information Gathering.

MongoDB

The following discussion of MongoDB is based on just my personal experience, so I am not covering all use cases. I have used MongoDB for:

  • Small clusters of MongoDB nodes to analyze social media data, mostly text mining and sentiment analysis. In all cases for each application I ran MongoDB with one write master (i.e., I wrote data to this one node but did not use it for reads) and multiple read-only slave nodes. Each slave node would run on the same server that was performing (usually) a single bit of analytics.
  • Multiple very large independent clusters for web advertising. Problems faced included trying to have some level of consistency across data centers. Replica sets were used within each data center.
  • Running a single node MongoDB instance for low volume data collection and analytics.

One of the advantages of MongoDB is that is very “developer friendly” because it supports ad-hoc document schemas and interactive queries. I mentioned that MongoDB allows you to choose consistency vs. availability vs. efficiency. When you perform MongoDB writes you can specify some granularity of what constitutes a “successful write” by requiring that a write is performed at a specific number of nodes before the client gets acknowledgement that the write was successful. This requirement adds overhead to each write operation and can cause writes to fail if some nodes are not available.

The MongoDB online documentation is very good. You don’t have to read it in order to have fun playing with the following Common Lisp and MongoDB examples, but if you find that MongoDB is a good fit for your needs after playing with these examples then you should read the documentation. I usually install MongoDB myself but it is sometimes convenient to use a hosting service. There are several well regarded services and I have used MongoHQ.

At this time there is no official Common Lisp support for accessing MongoDB but there is a useful project by Alfons Haffmans’ cl-mongo that will allow us to write Common Lisp client applications and have access to most of the capabilities of MongoDB.

The file src/mongo_news.lisp contains the example code used in the next three sessions.

Adding Documents

The following repl listing shows the cl-mongo APIs for creating a new document, adding elements (attributes) to it, and inserting it in a MongoDB data store:

(ql:quickload "cl-mongo")

(cl-mongo:db.use "news")

(defun add-article (uri title text)
  (let ((doc (cl-mongo:make-document)))
	(cl-mongo:add-element "uri" uri doc)
	(cl-mongo:add-element "title" title doc)
	(cl-mongo:add-element "text" text doc)
	(cl-mongo:db.insert "article" doc)))

;; add a test document:
(add-article "http://test.com" "article title 1" "article text 1")

In this example, three string attributes were added to a new document before it was saved.

Fetching Documents by Attribute

We will start by fetchng and pretty-printing all documents in the collection articles and fetching all articles a list of nested lists where the inner nested lists are document URI, title, and text:

 1 (defun print-articles ()
 2   (cl-mongo:pp (cl-mongo:iter (cl-mongo:db.find "article" :all))))
 3 
 4 ;; for each document, use the cl-mongo:get-element on
 5 ;; each element we want to save:
 6 (defun article-results->lisp-data (mdata)
 7   (let ((ret '()))
 8     ;;(print (list "size of result=" (length mdata)))
 9     (dolist (a mdata)
10       ;;(print a)
11       (push
12         (list
13          (cl-mongo:get-element "uri" a)
14          (cl-mongo:get-element "title" a)
15          (cl-mongo:get-element "text" a))
16         ret)))
17     ret))
18 
19 (defun get-articles ()
20   (article-results->lisp-data
21     (cadr (cl-mongo:db.find "article" :all))))

Output for these two functions looks like:

 1 * (print-articles)
 2 
 3 {
 4   "_id" -> objectid(99778A792EBB4F76B82F75C6)
 5   "uri"  ->  http://test.com/3
 6   "title"  ->  article title 3
 7   "text"  ->  article text 3
 8 }
 9 
10 {
11   "_id" -> objectid(D47DEF3CFDB44DEA92FD9E56)
12   "uri"  ->  http://test.com/2
13   "title"  ->  article title 2
14   "text"  ->  article text 2
15 }
16 
17 * (get-articles)
18 
19 (("http://test.com/2" "article title 2" "article text 2")
20  ("http://test.com/3" "article title 3" "article text 3"))

By reusing the function article-results->lisp-data defined in the last section, we can also search for JSON documents using regular expressions matching attribute values:

 1 ;; find documents where substring 'str' is in the title:
 2 (defun search-articles-title (str)
 3   (article-results->lisp-data
 4     (cadr
 5       (cl-mongo:iter
 6        (cl-mongo:db.find
 7          "article"
 8          (cl-mongo:kv
 9             "title"     // TITLE ATTRIBUTE
10             (cl-mongo:kv "$regex" str)) :limit 10)))))
11 
12 ;; find documents where substring 'str' is in the text element:
13 (defun search-articles-text (str) 
14   (article-results->lisp-data
15     (cadr
16       (cl-mongo:db.find
17         "article"
18         (cl-mongo:kv
19            "text"        // TEXT ATTRIBUTE
20            (cl-mongo:kv "$regex" str)) :limit 10))))

I set the limit to return a maximum of ten documents. If you do not set the limit, this example code only returns one search result. The following repl listing shows the results from calling function search-articles-text:

1 * (SEARCH-ARTICLES-TEXT "text")
2 
3 (("http://test.com/2" "article title 2" "article text 2")
4  ("http://test.com/3" "article title 3" "article text 3"))
5 * (SEARCH-ARTICLES-TEXT "3")
6 
7 (("http://test.com/3" "article title 3" "article text 3"))

I find using MongoDB to be especially effective when experimenting with data and code. The schema free JSON document format, using interactive queries using the mongo shell, and easy to use client libraries like clouchdb for Common Lisp will let you experiment with a lot of ideas in a short period of time. The following listing shows the use of the interactive mongo shell. The database news is the database used in the MongoDB examples in this chapter; you will notice that I also have other databases for other projects on my laptop:

 1 ->  src git:(master) mongo
 2 MongoDB shell version: 2.4.5
 3 connecting to: test
 4 > show dbs
 5 kbsportal	0.03125GB
 6 knowledgespace	0.03125GB
 7 local	(empty)
 8 mark_twitter	0.0625GB
 9 myfocus	0.03125GB
10 news	0.03125GB
11 nyt	0.125GB
12 twitter	0.125GB
13 > use news
14 switched to db news
15 > show collections
16 article
17 system.indexes
18 > db.article.find()
19 { "uri" : "http://test.com/3",
20  "title" : "article title 3",
21  "text" : "article text 3",
22  "_id" : ObjectId("99778a792ebb4f76b82f75c6") }
23 { "uri" : "http://test.com/2",
24  "title" : "article title 2",
25  "text" : "article text 2",
26  "_id" : ObjectId("d47def3cfdb44dea92fd9e56") }
27 > 

Line 1 of this listing shows starting the mongo shell. Line 4 shows how to list all databases in the data store. In line 13 I select the database “news” to use. Line 15 prints out the names of all collections in the current database “news”. Line 18 prints out all documents in the “articles” collection. You can read the documentation for the mongo shell for more options like selective queries, adding indices, etc.

When you run a MongoDB service on your laptop, also try the admin interface on http://localhost:28017/.

CouchDB

CouchDB provides replication services so JSON documents you store with a CouchDB service on your laptop, for instance, can replicate to CouchDB services on your remote servers. For the rest of this chapter we will look at some code examples for using CouchDB from Common Lisp applications.

Building CouchDB from source takes a while since you need Erlang and Javascript dependencies. You can download prebuilt binaries for Windows and Mac OS X and on Linux use sudo apt-get install couchdb. I also have found it useful to use the CouchDB hosting service Cloudant. Cloudant has open sourced a major piece of their infrastructure, a distributed version of CouchDB called BigCouch that you might want to consider if you need a very large distributed document data store.

Getting CouchDB Set Up

After you run a CouchDB service you can then use the web administration interface http://127.0.0.1:5984/_utils/index.html to create a new database news that we will use in these examples.

To install and use the clouchdb CouchDB client library and use the new news database:

(ql:quickload "clouchdb")
* clouchdb:*couchdb*

#S(CLOUCHDB::DB
   :HOST "localhost"
   :PORT "5984"
   :NAME "default"
   :PROTOCOL "http"
   :USER NIL
   :PASSWORD NIL
   :DOCUMENT-FETCH-FN NIL
   :DOCUMENT-UPDATE-FN NIL)
* (setf clouchdb:*couchdb*
        (clouchdb:make-db :name "news" :host "localhost"))

#S(CLOUCHDB::DB
   :HOST "localhost"
   :PORT "5984"
   :NAME "news"
   :PROTOCOL "http"
   :USER NIL
   :PASSWORD NIL
   :DOCUMENT-FETCH-FN NIL
   :DOCUMENT-UPDATE-FN NIL)

Notice that in line 7 that the database name is “default.” We want to change the database to “news” which we do in line 13. You can in a similar way change any other attributes in the couchdb::couchdb connection structure.

Adding Documents

CouchDB documents are stored as JSON data. The clouchdb library lets us deal with documents as Lisp lists and converts to and from JSON for us.

We can create a document passing a list of lists to the function clouchdb:create-document. The sub-lists are treated as hash table key/value pairs:

 1 (defvar *d1*
 2   (clouchdb:create-document
 3    '(("uri" . "test.com/news")
 4      ("title" . "Fishing Season")
 5      ("text" . "Fishing season opens tomorrow"))))
 6 * *d1*
 7 
 8 ((:|ok| . T) (:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
 9  (:|rev| . "1-3497880f631bd2cea12cdbf8c7d7553f"))
10 * (clouchdb:get-document "7ae9bee63100a7b449d4ae7a6c000b9c")
11 
12 ((:|_id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
13  (:|_rev| . "1-3497880f631bd2cea12cdbf8c7d7553f")
14  (:|uri| . "test.com/news")
15  (:|title| . "Fishing Season")
16  (:|text| . "Fishing season opens tomorrow"))

If you are still running the web administration interface you can look at database news, see one document that we just created, and inspect the data in the document:

CouchDB Admin Web App
CouchDB Admin Web App

Fetching Documents

CouchDB uses views that are pre-computed using map reduce programs written in Javascript. You don’t need to look at it right now, but if after experimenting with the examples in this chapter you decide to use CouchDB for your projects then you will need to read the CouchDB View Documentation.

The clouchdb documentation has several examples for using the parenscript library to convert Lisp to Javascript for views but I prefer just using Javascript. One reason for this is that I experiment with writing map reduce functions for creating views while inside the CouchDB Admin Web App in Javascript. I find that using parenscript is an unnecessary extra level of abstraction. The map reduce view functions I need are relatively simple, and I don’t mind writing them in Javascript.

The following listing shows a temporary view to return all documents that have an attribute title. The Javascript code in the call to clouchdb:ad-hoc-view should be all on one line, I manually reformatted it here for readability:

 1 * (clouchdb:ad-hoc-view
 2    "function(doc) {
 3 	 if (doc.title) {
 4 	   emit(null,doc.title)
 5 	 }
 6 	}")
 7 
 8 ((:|total_rows| . 1) (:|offset| . 0)
 9  (:|rows|
10   ((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c") (:|key|)
11    (:|value| . "Fishing Season"))))

You can also match on substrings. The following call to clouchdb:ad-hoc-view should be all on one line (once again, I manually reformatted it here for readability):

 1 * (clouchdb:ad-hoc-view
 2    "function(doc) {
 3 	 if (doc.title.indexOf('Season') != -1) {
 4 		 emit(null,doc.title)
 5 	 }
 6 	}")
 7 
 8 ((:|total_rows| . 1) (:|offset| . 0)
 9  (:|rows|
10   ((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
11    (:|key|)
12    (:|value| . "Fishing Season"))))

Please note that ad-hoc views are very inefficient but useful during development. In production you will create named views for specific queries. The CouchDB service will keep the view up to date for you automatically as documents are created, modified, and removed. The following listing shows a “design” document that is used to define a view:

 1 {
 2   "_id": "_design/titleview",
 3   "_rev": "4-3ce2dfe67576066c94da9fb5e80b8fdc",
 4   "language": "javascript",
 5   "views": {
 6     "season": {
 7       "map":
 8       "function(doc) {
 9 	     if (doc.title.indexOf('Season')!=-1) emit(null, doc)
10 	   }"
11     }
12   }
13 }

Note the form of the attribute _id which is important: the string “_design/” followed by the name of the view. In general, you might define multiple views in a single “design” document, but I only defined one here named “season.” Also note that the “season” view only has a map function, not a reduce function. The pattern of using only a map function is common when you want to select a set of documents based on some selection criteria. Using map and reduce functions is useful when you are aggregating data from many documents together.

The following figure shows the CouchDB admin web app while I was editing this view:

CouchDB Admin Web App: editing a view
CouchDB Admin Web App: editing a view

You can run this view using:

 1 * (clouchdb:invoke-view "titleview" "season")
 2 
 3 ((:|total_rows| . 1) (:|offset| . 0)
 4  (:|rows|
 5   ((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c") (:|key|)
 6    (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
 7     (:|_rev| . "1-3497880f631bd2cea12cdbf8c7d7553f")
 8     (:|uri| . "test.com/news")
 9     (:|title| . "Fishing Season")
10     (:|text| . "Fishing season opens tomorrow")))))

The call to function clouchdb:invoke-view on line 1 references the name of the design documents without the prefix “_design/” and the name of the view “season” that was defined in this “design” document.

Accessing Document Attributes

If we add an additional test document with “Season” in its title and re-run the view from the last section, we now have two matching results when calling the function clouchdb:invoke-view:

 1 * (defvar *results* (clouchdb:invoke-view "titleview" "season"))
 2 
 3 *RESULTS*
 4 * *results*
 5 
 6 ((:|total_rows| . 2) (:|offset| . 0)
 7  (:|rows|
 8   ((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c") (:|key|)
 9    (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
10     (:|_rev| . "1-3497880f631bd2cea12cdbf8c7d7553f")
11     (:|uri| . "test.com/news")
12     (:|title| . "Fishing Season")
13     (:|text| . "Fishing season opens tomorrow")))
14   ((:|id| . "7ae9bee63100a7b449d4ae7a6c0019c6") (:|key|)
15    (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c0019c6")
16     (:|_rev| . "1-1c213a425457a470cad1892e5cf10c1d")
17     (:|uri| . "test.com/news")
18     (:|title| . "Fishing Season")
19     (:|text| . "Fishing season opens tomorrow 3")))))
20 * (cdaddr *results*)
21 
22 (((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c") (:|key|)
23   (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
24    (:|_rev| . "1-3497880f631bd2cea12cdbf8c7d7553f")
25    (:|uri| . "test.com/news")
26    (:|title| . "Fishing Season")
27    (:|text| . "Fishing season opens tomorrow")))
28  ((:|id| . "7ae9bee63100a7b449d4ae7a6c0019c6") (:|key|)
29   (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c0019c6")
30    (:|_rev| . "1-1c213a425457a470cad1892e5cf10c1d")
31    (:|uri| . "test.com/news")
32    (:|title| . "Fishing Season")
33    (:|text| . "Fishing season opens tomorrow 3"))))
34 * (dolist (r (cdaddr *results*))
35    (print r)
36    (terpri))
37 
38 ((:|id| . "7ae9bee63100a7b449d4ae7a6c000b9c") (:|key|)
39  (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c000b9c")
40   (:|_rev| . "1-3497880f631bd2cea12cdbf8c7d7553f")
41   (:|uri| . "test.com/news")
42   (:|title| . "Fishing Season")
43   (:|text| . "Fishing season opens tomorrow"))) 
44 
45 ((:|id| . "7ae9bee63100a7b449d4ae7a6c0019c6") (:|key|)
46  (:|value| (:|_id| . "7ae9bee63100a7b449d4ae7a6c0019c6")
47   (:|_rev| . "1-1c213a425457a470cad1892e5cf10c1d")
48   (:|uri| . "test.com/news")
49   (:|title| . "Fishing Season")
50   (:|text| . "Fishing season opens tomorrow 3"))) 
51 NIL
52 * (defun print-doc (doc) (print (cdddr (caddr doc))))
53 
54 PRINT-DOC
55 * (dolist (r (cdaddr *results*)) (print-doc r) (terpri))
56 
57 ((:|uri| . "test.com/news")
58  (:|title| . "Fishing Season")
59  (:|text| . "Fishing season opens tomorrow")) 
60 
61 ((:|uri| . "test.com/news")
62  (:|title| . "Fishing Season")
63  (:|text| . "Fishing season opens tomorrow 3")) 
64 NIL
65 * (defun print-doc (doc)
66    (let ((x (cdddr (caddr doc))))
67     (print
68       (list
69        "title:"
70        (cdadr x) "text:" (cdaddr x)))))
71 STYLE-WARNING: redefining COMMON-LISP-USER::PRINT-DOC in DEFUN
72 
73 PRINT-DOC
74 * (dolist (r (cdaddr *results*))
75     (print-doc r)
76     (terpri))
77 
78 ("title:" "Fishing Season" "text:" "Fishing season opens tomorrow") 
79 
80 ("title:" "Fishing Season" "text:" "Fishing season opens tomorrow 3") 
81 NIL

A Common Lisp Solr Client

The Lucene project is one of the most widely used Apache Foundation projects. Lucene is a flexible library for preprocessing and indexing text, and searching text. I have personally used Lucene on so many projects that it would be difficult counting them. The Apache Solr Project adds a network interface to the Lucene text indexer and search engine. Solr also adds other utility features to Lucene:

  • While Lucene is a library to embedded in your programs, Solr is a complete system.
  • Solr provides good defaults for preprocessing and indexing text and also provided rich support for managing structured data.
  • Provides both XML and JSON APIs using HTTP and REST.
  • Supports faceted search, geospatial search, and provides utilities for highlighting search terms in surrounding text of search results.
  • If your system ever grows to a very large number of users, Solr supports scaling via replication.

I hope that you will find the Common Lisp example Solr client code in the following sections helps you make Solr part of large systems that you write using Common Lisp.

Installing Solr

Download a binary Solr distribution and un-tar or un-zip this Solr distribution, cd to the distribution directory, then cd to the example directory and run:

1  ~/solr/example>  java -jar start.jar

You can access the Solr Admin Web App at http://localhost:8983/solr/#/. This web app can be seen in the following screen shot:

Solr Admin Web App
Solr Admin Web App

There is no data in the Solr example index yet, so following the Solr tutorial instructions:

 1  ~/> cd ~/solr/example/exampledocs
 2  ~/solr/example/exampledocs> java -jar post.jar *.xml
 3 SimplePostTool version 1.5
 4 Posting files to base url http://localhost:8983/solr/update
 5         using content-type application/xml..
 6 POSTing file gb18030-example.xml
 7 POSTing file hd.xml
 8 POSTing file ipod_other.xml
 9 POSTing file ipod_video.xml
10 POSTing file manufacturers.xml
11 POSTing file mem.xml
12 POSTing file money.xml
13 POSTing file monitor.xml
14 POSTing file monitor2.xml
15 POSTing file mp500.xml
16 POSTing file sd500.xml
17 POSTing file solr.xml
18 POSTing file utf8-example.xml
19 POSTing file vidcard.xml
20 14 files indexed.
21 COMMITting Solr index changes
22            to http://localhost:8983/solr/update..
23 Time spent: 0:00:00.480

You will learn how to add documents to Solr directly in your Common Lisp programs in a later section.

Assuming that you have a fast Internet connection so downloading Solr was quick, you have hopefully spent less than five or six minutes getting Solr installed and running with enough example search data for the Common Lisp client examples we will play with. Solr is a great tool for storing, indexing, and searching data. I recommend that you put off reading the official Solr documentation for now and instead work through the Common Lisp examples in the next two sections. Later, if you want to use Solr then you will need to carefully read the Solr documentation.

Solr’s REST Interface

The Solr REST Interface Documentation documents how to perform search using HTTP GET requests. All we need to do is implement this in Common Lisp which you will see is easy.

Assuming that you have Solr running and the example data loaded, we can try searching for documents with, for example, the word “British” using the URL http://localhost:8983/solr/select?q=British. This is a REST request URL and you can use utilities like curl or wget to fetch the XML data. I fetched the data in a web browser, as seen in the following screen shot of a Firefox web browser (I like the way Firefox formats and displays XML data):

Solr Search Results as XML Data
Solr Search Results as XML Data

The attributes in the returned search results need some explanation. We indexed several example XML data files, one of which contained the following XML element that we just saw as a search result:

 1 <doc>
 2   <field name="id">GBP</field>
 3   <field name="name">One British Pound</field>
 4   <field name="manu">U.K.</field>
 5   <field name="manu_id_s">uk</field>
 6   <field name="cat">currency</field>
 7   <field name="features">Coins and notes</field>
 8   <field name="price_c">1,GBP</field>
 9   <field name="inStock">true</field>
10 </doc>

So, the search result has the same attributes as the structured XML data that was added to the Solr search index. Solr’s capability for indexing structured data is a superset of just indexing plain text. As an example, if we were indexing news stories, then example input data might look like:

1 <doc>
2   <field name="id">new_story_0001</field>
3   <field name="title">Fishing Season Opens</field>
4   <field name="text">Fishing season opens on Friday in Oak Creek.</field>
5 </doc>

With this example, a search result that returned this document as a result would return attributes id, title, and text, and the values of these three attributes.

By default the Solr web service returns XML data as seen in the last screen shot. For our examples, I prefer using JSON so we are going to always add a request parameter wt=json to all REST calls. The following screen shot shows the same data returned in JSON serialization format instead of XML format of a Chrome web browser (I like the way Chrome formats and displays JSON data with the JSONView Chrome Browser extension):

Solr Search Results as JSON Data
Solr Search Results as JSON Data

You can read the full JSON REST Solr documentation later, but for our use here we will use the following search patterns:

  • http://localhost:8983/solr/select?q=British+One&wt=json - search for documents with either of the words “British” or “one” in them. Note that in URIs that the “+” character is used to encode a space character. If you wanted a “+” character you would encode it with “%2B” and a space character is encoded as “%20”. The default Solr search option is an OR of the search terms, unlike for example Google Search.
  • http://localhost:8983/solr/select?q=British+AND+one&wt=json - search for documents that contain both of the words “British” and “one” in them. The search term in plain text is “British AND one”.

As we saw in the earlier in Network Programming it is fairly simple to use the drakma and cl-json Common Lisp libraries to call REST services that return JSON data. The function do-search defined in the next listing (all the Solr example code is in the file src/solr-client.lisp) constructs a query URI as we saw in the last section and uses the Drackma library to perform an HTTP GET operation and the cl-json library to parse the returned string containing JSON data into Lisp data structures:

(ql:quickload :drakma)
(ql:quickload :cl-json)

(defun do-search (&rest terms)
  (let ((query-string (format nil "~{~A~^+AND+~}" terms)))
   (cl-json:decode-json-from-string
     (drakma:http-request
       (concatenate 
        'string
        "http://localhost:8983/solr/select?q="
        query-string
        "&wt=json")))))

This example code does return the search results as Lisp list data; for example:

 1 * (do-search "British" "one")
 2 
 3 ((:RESPONSE-HEADER (:STATUS . 0) (:*Q-TIME . 1)
 4   (:PARAMS (:Q . "British+AND+one") (:WT . "json")))
 5  (:RESPONSE (:NUM-FOUND . 6) (:START . 0)
 6   (:DOCS
 7    ((:ID . "GBP") (:NAME . "One British Pound") (:MANU . "U.K.")
 8     (:MANU--ID--S . "uk") (:CAT "currency")
 9     (:FEATURES "Coins and notes")
10     (:PRICE--C . "1,GBP") (:IN-STOCK . T)
11     (:--VERSION-- . 1440194917628379136))
12    ((:ID . "USD") (:NAME . "One Dollar")
13     (:MANU . "Bank of America")
14     (:MANU--ID--S . "boa") (:CAT "currency")
15     (:FEATURES "Coins and notes")
16     (:PRICE--C . "1,USD") (:IN-STOCK . T)
17     (:--VERSION-- . 1440194917624184832))
18    ((:ID . "EUR") (:NAME . "One Euro")
19     (:MANU . "European Union")
20     (:MANU--ID--S . "eu") (:CAT "currency")
21     (:FEATURES "Coins and notes")
22     (:PRICE--C . "1,EUR") (:IN-STOCK . T)
23     (:--VERSION-- . 1440194917626281984))
24    ((:ID . "NOK") (:NAME . "One Krone")
25     (:MANU . "Bank of Norway")
26     (:MANU--ID--S . "nor") (:CAT "currency")
27     (:FEATURES "Coins and notes")
28     (:PRICE--C . "1,NOK") (:IN-STOCK . T)
29     (:--VERSION-- . 1440194917631524864))
30    ((:ID . "0579B002")
31     (:NAME . "Canon PIXMA MP500 All-In-One Photo Printer")
32     (:MANU . "Canon Inc.")
33     (:MANU--ID--S . "canon")
34     (:CAT "electronics" "multifunction printer"
35      "printer" "scanner" "copier")
36     (:FEATURES "Multifunction ink-jet color photo printer"
37      "Flatbed scanner, optical scan resolution of 1,200 x 2,400 dpi"
38      "2.5\" color LCD preview screen" "Duplex Copying"
39      "Printing speed up to 29ppm black, 19ppm color" "Hi-Speed USB"
40      "memory card: CompactFlash, Micro Drive, SmartMedia,
41       Memory Stick, Memory Stick Pro, SD Card, and MultiMediaCard")
42     (:WEIGHT . 352.0) (:PRICE . 179.99)
43     (:PRICE--C . "179.99,USD")
44     (:POPULARITY . 6) (:IN-STOCK . T)
45     (:STORE . "45.19214,-93.89941")
46     (:--VERSION-- . 1440194917651447808))
47    ((:ID . "SOLR1000")
48     (:NAME . "Solr, the Enterprise Search Server")
49     (:MANU . "Apache Software Foundation")
50     (:CAT "software" "search")
51     (:FEATURES "Advanced Full-Text Search Capabilities using Lucene"
52      "Optimized for High Volume Web Traffic"
53      "Standards Based Open Interfaces - XML and HTTP"
54      "Comprehensive HTML Administration Interfaces"
55      "Scalability - Efficient Replication to other Solr Search Servers"
56      "Flexible and Adaptable with XML configuration and Schema"
57      "Good unicode support: héllo (hello with an accent over the e)")
58     (:PRICE . 0.0) (:PRICE--C . "0,USD") (:POPULARITY . 10) (:IN-STOCK . T)
59     (:INCUBATIONDATE--DT . "2006-01-17T00:00:00Z")
60     (:--VERSION-- . 1440194917671370752)))))

I might modify the search function to return just the fetched documents as a list, discarding the returned Solr meta data:

 1 * (cdr (cadddr (cadr (do-search "British" "one"))))
 2 
 3 (((:ID . "GBP") (:NAME . "One British Pound") (:MANU . "U.K.")
 4   (:MANU--ID--S . "uk") (:CAT "currency") (:FEATURES "Coins and notes")
 5   (:PRICE--C . "1,GBP") (:IN-STOCK . T)
 6   (:--VERSION-- . 1440194917628379136))
 7  ((:ID . "USD") (:NAME . "One Dollar") (:MANU . "Bank of America")
 8   (:MANU--ID--S . "boa") (:CAT "currency") (:FEATURES "Coins and notes")
 9   (:PRICE--C . "1,USD") (:IN-STOCK . T)
10   (:--VERSION-- . 1440194917624184832))
11  ((:ID . "EUR") (:NAME . "One Euro") (:MANU . "European Union")
12   (:MANU--ID--S . "eu") (:CAT "currency") (:FEATURES "Coins and notes")
13   (:PRICE--C . "1,EUR") (:IN-STOCK . T)
14   (:--VERSION-- . 1440194917626281984))
15  ((:ID . "NOK") (:NAME . "One Krone") (:MANU . "Bank of Norway")
16   (:MANU--ID--S . "nor") (:CAT "currency")
17   (:FEATURES "Coins and notes")
18   (:PRICE--C . "1,NOK") (:IN-STOCK . T)
19   (:--VERSION-- . 1440194917631524864))
20  ((:ID . "0579B002")
21   (:NAME . "Canon PIXMA MP500 All-In-One Photo Printer")
22   (:MANU . "Canon Inc.") (:MANU--ID--S . "canon")
23   (:CAT "electronics" "multifunction printer" "printer"
24    "scanner" "copier")
25   (:FEATURES "Multifunction ink-jet color photo printer"
26    "Flatbed scanner, optical scan resolution of 1,200 x 2,400 dpi"
27    "2.5\" color LCD preview screen" "Duplex Copying"
28    "Printing speed up to 29ppm black, 19ppm color" "Hi-Speed USB"
29    "memory card: CompactFlash, Micro Drive, SmartMedia, Memory Stick,
30     Memory Stick Pro, SD Card, and MultiMediaCard")
31   (:WEIGHT . 352.0) (:PRICE . 179.99) (:PRICE--C . "179.99,USD")
32   (:POPULARITY . 6) (:IN-STOCK . T) (:STORE . "45.19214,-93.89941")
33   (:--VERSION-- . 1440194917651447808))
34  ((:ID . "SOLR1000") (:NAME . "Solr, the Enterprise Search Server")
35   (:MANU . "Apache Software Foundation") (:CAT "software" "search")
36   (:FEATURES "Advanced Full-Text Search Capabilities using Lucene"
37    "Optimized for High Volume Web Traffic"
38    "Standards Based Open Interfaces - XML and HTTP"
39    "Comprehensive HTML Administration Interfaces"
40    "Scalability - Efficient Replication to other Solr Search Servers"
41    "Flexible and Adaptable with XML configuration and Schema"
42    "Good unicode support: héllo (hello with an accent over the e)")
43   (:PRICE . 0.0) (:PRICE--C . "0,USD") (:POPULARITY . 10) (:IN-STOCK . T)
44   (:INCUBATIONDATE--DT . "2006-01-17T00:00:00Z")
45   (:--VERSION-- . 1440194917671370752)))

There are a few more important details if you want to add Solr search to your Common Lisp applications. When there are many search results you might want to fetch a limited number of results and then “page” through them. The following strings can be added to the end of a search query:

  • &rows=2 this example returns a maximum of two “rows” or two query results.
  • &start=4 this example skips the first 4 available results

A query that combines skipping results and limiting the number of returned results looks like this:

1 http://localhost:8983/solr/select?q=British+One&wt=json&start=2&rows=2

Common Lisp Solr Client for Adding Documents

In the last example we relied on adding example documents to the Solr search index using the directions for setting up a new Solr installation. In a real application, in addition to performing search requests for indexed documents you will need to add new documents from your Lisp applications. Using the Drakma we will see that it is very easy to add documents.

We need to construct a bit of XML containing new documents in the form:

1 <add>
2     <doc>
3         <field name="id">123456</field>
4         <field name="title">Fishing Season</field>
5     </doc>
6 </add>

You can specify whatever field names (attributes) that are required for your application. You can also pass multiple <doc></doc> elements in one add request. We will want to specify documents in a Lisp like way: a list of cons values where each cons value is a field name and a value. For the last XML document example we would like an API that lets us just deal with Lisp data like:

 (do-add '(("id" . "12345")
           ("title" . "Fishing Season")))

One thing to note: the attribute names and values must be passed as strings. Other data types like integers, floating point numbers, structs, etc. will not work.

This is nicer than having to use XML, right? The first thing we need is a function to convert a list of cons values to XML. I could have used the XML Builder functionality in the cxml library that is available via Quicklisp, but for something this simple I just wrote it in pure Common Lisp with no other dependencies (also in the example file src/solr-client.lisp) :

 1 (defun keys-values-to-xml-string  (keys-values-list)
 2  (with-output-to-string (stream)
 3    (format stream "<add><doc>")
 4    (dolist (kv keys-values-list)
 5      (format stream "<field name=\"")
 6      (format stream (car kv))
 7      (format stream "\">")
 8      (format stream (cdr kv))
 9      (format stream "\"</field>"))
10    (format stream "</doc></add>")))

The macro with-output-to-string on line 2 of the listing is my favorite way to generate strings. Everything written to the variable stream inside the macro call is appended to a string; this string is the return value of the macro.

The following function adds documents to the Solr document input queue but does not actually index them:

1 (defun do-add (keys-values-list)
2   (drakma:http-request
3    "http://localhost:8983/solr/update"
4    :method :post
5    :content-type "application/xml"
6    :content ( keys-values-to-xml-string  keys-values-list)))

You have noticed in line 3 that I am accessing a Solr server running on localhost and not a remote server. In an application using a remote Solr server you would need to modify this to reference your server; for example:

1 "http://solr.knowledgebooks.com:8983/solr/update"

For efficiency Solr does not immediately add new documents to the index until you commit the additions. The following function should be called after you are done adding documents to actually add them to the index:

(defun commit-adds ()
  (drakma:http-request
   "http://localhost:8983/solr/update"
   :method :post
   :content-type "application/xml"
   :content "<commit></commit>"))

Notice that all we need is an empty element <commit></commit> that signals the Solr server that it should index all recently added documents. The following repl listing shows everything working together (I am assuming that the contents of the file src/solr-client.lisp has been loaded); not all of the output is shown in this listing:

* (do-add '(("id" . "12345") ("title" . "Fishing Season")))

200
((:CONTENT-TYPE . "application/xml; charset=UTF-8")
 (:CONNECTION . "close"))
#<PURI:URI http://localhost:8983/solr/update>
#<FLEXI-STREAMS:FLEXI-IO-STREAM {1009193133}>
T
"OK"
* (commit-adds)

200
((:CONTENT-TYPE . "application/xml; charset=UTF-8")
 (:CONNECTION . "close"))
#<PURI:URI http://localhost:8983/solr/update>
#<FLEXI-STREAMS:FLEXI-IO-STREAM {10031F20B3}>
T
"OK"
* (do-search "fishing")

((:RESPONSE-HEADER (:STATUS . 0) (:*Q-TIME . 2)
  (:PARAMS (:Q . "fishing") (:WT . "json")))
 (:RESPONSE (:NUM-FOUND . 1) (:START . 0)
  (:DOCS
   ((:ID . "12345\"") (:TITLE "Fishing Season\"")
    (:--VERSION-- . 1440293991717273600)))))
*

Common Lisp Solr Client Wrap Up

Solr has a lot of useful features that we have not used here like supporting faceted search (drilling down in previous search results), geolocation search, and looking up indexed documents by attribute. In the examples I have shown you, all text fields are indexed but Solr optionally allows you fine control over indexing, spelling correction, word stemming, etc.

Solr is a very capable tool for storing, indexing, and searching data. I have seen Solr used effectively on projects as a replacement for a relational database or other NoSQL data stores like CouchDB or MongoDB. There is a higher overhead for modifying or removing data in Solr so for applications that involve frequent modifications to stored data Solr might not be a good choice.

NoSQL Wrapup

There are more convenient languages than Common Lisp to use for accessing MongoDB and CouchDB. To be honest, my favorites are Ruby and Clojure. That said, for applications where the advantages of Common Lisp are compelling, it is good to know that your Common Lisp applications can play nicely with MongoDB and CouchDB.

I am a polyglot programmer: I like to use the best programming language for any specific job. When we design and build systems with more than one programming language, there are several options to share data:

  • Use foreign function interfaces to call one language from another from inside one process.
  • Use a service architecture and send requests using REST or SOAP.
  • Use shared data stores, like relational databases, MongoDB, CouchDB and Solr.

Hopefully this chapter and the last chapter will provide most of what you need for the last option.

Natural Language Processing

Natural Language Processing (NLP) is the automated processing of natural language text with several goals:

  • Determine the parts of speech (POS tagging) of words based on the surrounding words.
  • Detect if two text documents are similar.
  • Categorize text (e.g., is it about the economy, politics, sports, etc.)
  • Summarize text
  • Determine the sentiment of text
  • Detect names (e.g., place names, people’s names, product names, etc.)

We will use a library that I wrote that performs POS tagging, categorization (classification), summarization, and detects proper names.

The example code for this chapter is contained in the file src/knowledgebooks_nlp.lisp and needs to load the data in the directory src/data. I worked on this Lisp code, and also similar code in Java, from about 2001 to 2011. While I still use my own Common Lisp library (and a newer Ruby version KBSPortal.com) I no longer actively develop my libraries for NLP. In any case I hope you find the following code interesting and useful. I am going to start in the next section with a quick explanation of how to run the example code. If you find the examples interesting then you can also read the rest of this chapter where I explain how the code works.

The approach that I used in my library for categorization (word counts) is now dated. I recommend that you consider taking Andrew Ng’s course on Machine Learning on the free online Coursera system and then take one of the Coursera NLP classes for a more modern treatment of NLP.

In addition to the code for my library you might also find the linguistic data in src/data useful.

Loading and Running the NLP Library

I repackaged the NLP example code into one long file. The code used to be split over 18 source files. The code should be loaded from the src directory:

1 %  loving-common-lisp git:(master) > cd src
2 %  src git:(master) > sbcl
3 * (load "knowledgebooks_nlp.lisp")
4 
5 "Startng to load data...." 
6 "....done loading data." 
7 *

Unfortunately, it takes a few minutes to load the required linguistic data so I recommend creating a Lisp image that can be reloaded to avoid the time required to load the data:

1 * (sb-ext:save-lisp-and-die "nlp-image" :purify t)
2 [undoing binding stack and other enclosing state... done]
3 [saving current Lisp image into nlp-image:
4 writing 5280 bytes from the read-only space at 0x0x20000000
5 writing 3088 bytes from the static space at 0x0x20100000
6 writing 80052224 bytes from the dynamic space at 0x0x1000000000
7 done]
8 %  src git:(master) > ls -lh nlp-image
9 -rw-r--r--  1 markw  staff    76M Jul 13 12:49 nlp-image

In line 1 in this repl listing, I use the SBCL built-in function save-lisp-and-die to create the Lisp image file. Using save-lisp-and-die is a great technique to use whenever it takes a while to set up your work environment. Saving a Lisp image for use the next time you work on a Common Lisp project is reminiscent of working in Smalltalk where your work is saved between sessions in an image file.

You can now start SBCL with the NLP library and data preloaded using the Lisp image that you just created:

 1 %  src git:(master) > sbcl --core nlp-image 
 2 * (in-package :kbnlp)
 3 
 4 #<PACKAGE "KBNLP">
 5 * (defvar
 6    *x*
 7    (make-text-object
 8      "President Bob Smith talked to Congress about the economy and taxes"))
 9 
10 *X*
11 
12 * *X*
13 
14 #S(TEXT
15    :URL ""
16    :TITLE ""
17    :SUMMARY "<no summary>"
18    :CATEGORY-TAGS (("news_politics.txt" 0.01648)
19                    ("news_economy.txt" 0.01601))
20    :KEY-WORDS NIL
21    :KEY-PHRASES NIL
22    :HUMAN-NAMES ("President Bob Smith")
23    :PLACE-NAMES NIL
24    :TEXT #("President" "Bob" "Smith" "talked" "to" "Congress" "about" "the"
25            "economy" "and" "taxes")
26    :TAGS #("NNP" "NNP" "NNP" "VBD" "TO" "NNP" "IN" "DT" "NN" "CC" "NNS")
27    :STEMS #("presid" "bob" "smith" "talk" "to" "congress" "about" "the"
28             "economi" "and" "tax"))
29 * 

At the end of the file src/knowledgebooks_nlp.lisp in comments is some test code that processes much more text so that a summary is also generated; here is a bit of the output you will see if you load the test code into your repl:

 1 (:SUMMARY
 2   "Often those amendments are an effort to change government policy
 3    by adding or subtracting money for carrying it out. The initial
 4    surge in foreclosures in 2007 and 2008 was tied to subprime
 5    mortgages issued during the housing boom to people with shaky
 6    credit. 2 trillion in annual appropriations bills for funding
 7    most government programs — usually low profile legislation that
 8    typically dominates the work of the House in June and July.
 9    Bill Clinton said that banking in Europe is a good business.
10    These days homeowners who got fixed rate prime mortgages because
11    they had good credit can not make their payments because they are
12    out of work. The question is whether or not the US dollar remains
13    the world s reserve currency if not the US economy will face
14    a depression."
15 :CATEGORY-TAGS (("news_politics.txt" 0.38268)
16                 ("news_economy.txt" 0.31182)
17                 ("news_war.txt" 0.20174))
18 :HUMAN-NAMES ("President Bill Clinton")
19 :PLACE-NAMES ("Florida"))

The top-level function make-text-object takes one required argument that can be either a string containing text or an array of strings where each string is a word or punctuation. Function make-text-object has two optional keyword parameters: the URL where the text was found and a title.

 1 (defun make-text-object (words &key (url "") (title ""))
 2   (if (typep words 'string) (setq words (words-from-string words)))
 3   (let* ((txt-obj (make-text :text words :url url :title title)))
 4     (setf (text-tags txt-obj) (part-of-speech-tagger words))
 5     (setf (text-stems txt-obj) (stem-text txt-obj))
 6     ;; note: we must find human and place names before calling
 7     ;; pronoun-resolution:
 8     (let ((names-places (find-names-places txt-obj)))
 9       (setf (text-human-names txt-obj) (car names-places))
10       (setf (text-place-names txt-obj) (cadr names-places)))
11     (setf (text-category-tags txt-obj)
12           (mapcar
13             #'(lambda (x)
14                 (list
15                   (car x)
16                   (/ (cadr x) 1000000.0)))
17             (get-word-list-category (text-text txt-obj))))
18     (setf (text-summary txt-obj) (summarize txt-obj))
19     txt-obj))

In line 2, we check if this function was called with a string containing text in which case the function words-from-string is used to tokenize the text into an array of string tokens. Line two defines the local variable txt-obj with the value of a new text object with only three slots (attributes) defined: text, url, and title. Line 4 sets the slot text-tags to the part of speech tokens using the function part-of-speech-tagger. We use the function find-names-places in line 8 to get person and place names and store these values in the text object. In lines 11 through 17 we use the function get-word-list-category to set the categories in the text object. In line 18 we similarly use the function summarize to calculate a summary of the text and also store it in the text object. We will discuss these NLP helper functions throughout the rest of this chapter.

The function make-text-object returns a struct that is defined as:

(defstruct text
  url
  title
  summary
  category-tags
  key-words
  key-phrases
  human-names
  place-names
  text
  tags
  stems)

Part of Speech Tagging

This tagger is the Common Lisp implementation of my FastTag open source project. I based this project on Eric Brill’s PhD thesis (1995). He used machine learning on annotated text to learn tagging rules. I used a subset of the tagging rules that he generated that were most often used when he tested his tagger. I hand coded his rules in Lisp (and Ruby, Java, and Pascal). My tagger is less accurate, but it is fast - thus the name FastTag.

You can find the tagger implementation in the function part-of-speech-tagger. We already saw sample output from the tagger in the last section:

1 :TEXT #("President" "Bob" "Smith" "talked" "to" "Congress" "about" "the"
2         "economy" "and" "taxes")
3 :TAGS #("NNP" "NNP" "NNP" "VBD" "TO" "NNP" "IN" "DT" "NN" "CC" "NNS")

The following table shows the meanings of the tags and a few example words:

Tag Definition Example words
CC Coord Conjuncn and, but, or
NN Noun, sing. or mass dog
CD Cardinal number one, two
NNS Noun, plural dogs, cats
DT Determiner the, some
NNP Proper noun, sing. Edinburgh
EX Existential there there
NNPS Proper noun, plural Smiths
FW Foreign Word mon dieu
PDT Predeterminer all, both
IN Preposition of, in, by
POS Possessive ending ’s
JJ Adjective big
PP Personal pronoun I, you, she
JJR Adj., comparative bigger
PP$ Possessive pronoun my, one’s
JJS Adj., superlative biggest
RB Adverb quickly
LS List item marker 1, One
RBR Adverb, comparative faster
MD Modal can, should
RBS Adverb, superlative fastest
RP Particle up, off
WP$ Possessive-Wh whose
SYM Symbol +, %, &
WRB Wh-adverb how, where
TO “to” to
$ Dollar sign $
UH Interjection oh, oops
# Pound sign #
VB verb, base form eat, run
quote
VBD verb, past tense ate
VBG verb, gerund eating
( Left paren (
VBN verb, past part eaten
) Right paren )
VBP Verb, present eat
, Comma ,
VBZ Verb, present eats
. Sent-final punct . ! ?
WDT Wh-determiner which, that
: Mid-sent punct. : ; —
WP Wh pronoun who, what

The function part-of-speech-tagger loops through all input words and initially assigns the most likely part of speech as specified in the lexicon. Then a subset of Brill’s rules are applied. Rules operate on the current word and the previous word.

As an example Common Lisp implementation of a rule, look for words that are tagged as common nouns, but end in “ing” so they should be a gerand (verb form):

  ; rule 8: convert a common noun to a present 
  ;         participle verb (i.e., a gerand)
  (if (equal (search "NN" r) 0)
    (let ((i (search "ing" w :from-end t)))
      (if (equal i (- (length w) 3))
          (setq r "VBG"))))

You can find the lexicon data in the file src/data/FastTagData.lisp. This file is List code instead of plain data (that in retrospect would be better because it would load faster) and looks like:

(defvar lex-hash (make-hash-table :test #'equal :size 110000))
(setf (gethash "shakeup" lex-hash) (list "NN"))
(setf (gethash "Laurance" lex-hash) (list "NNP"))
(setf (gethash "expressing" lex-hash) (list "VBG"))
(setf (gethash "citybred" lex-hash) (list "JJ"))
(setf (gethash "negative" lex-hash) (list "JJ" "NN"))
(setf (gethash "investors" lex-hash) (list "NNS" "NNPS"))
(setf (gethash "founding" lex-hash) (list "NN" "VBG" "JJ"))

I generated this file automatically from lexicon data using a small Ruby script. Notice that words can have more than one possible part of speech. The most common part of speech for a word is the first entry in the lexicon.

Categorizing Text

The code to categorize text is fairly simple using a technique often called “bag of words.” I collected sample text in several different categories and for each category (like politics, sports, etc.) I calculated the evidence or weight that words contribute to supporting a category. For example, the word “president” has a strong weight for the category “politics” but not for the category “sports.” The reason is that the word “president” occurs frequently in articles and books about politics. The data file that contains the word weightings for each category is src/data/cat-data-tables.lisp. You can look at this file; here is a very small part of it:

;;;  Starting topic: news_economy.txt

(setf *h* (make-hash-table :test #'equal :size 1000))

  (setf (gethash "news" *h*) 3915)
  (setf (gethash "debt" *h*) 3826)
  (setf (gethash "money" *h*) 1809)
  (setf (gethash "work" *h*) 1779)
  (setf (gethash "business" *h*) 1631)
  (setf (gethash "tax" *h*) 1572)
  (setf (gethash "poverty" *h*) 1512)

This file was created by a simple Ruby script (not included with the book’s example code) that processes a list of sub-directories, one sub-directory per category. The following listing shows the implementation of function get-word-list-category that calculates category tags for input text:

 1 (defun get-word-list-category (words)
 2   (let ((x nil)
 3         (ss nil)
 4         (cat-hash nil)
 5         (word nil)
 6         (len (length words))
 7         (num-categories (length categoryHashtables))
 8         (category-score-accumulation-array
 9           (make-array num-categories :initial-element 0)))
10 
11     (defun list-sort (list-to-sort)
12       ;;(pprint list-to-sort)
13       (sort list-to-sort
14 	    #'(lambda (list-element-1 list-element-2)
15 		(> (cadr list-element-1) (cadr list-element-2)))))
16 
17     (do ((k 0 (+ k 1)))
18         ((equal k len))
19       (setf word (string-downcase (aref words k)))
20       (do ((i 0 (+ i 1)))
21           ((equal i num-categories))
22         (setf cat-hash (nth i categoryHashtables))
23         (setf x (gethash word cat-hash))
24         (if x
25             (setf 
26               (aref category-score-accumulation-array i)
27               (+ x (aref category-score-accumulation-array i))))))
28     (setf ss '())
29     (do ((i 0 (+ i 1)))
30         ((equal i num-categories))
31       (if (> (aref category-score-accumulation-array i) 0.01)
32           (setf
33             ss
34             (cons
35               (list
36                 (nth i categoryNames)
37                 (round (* (aref category-score-accumulation-array i) 10)))
38               ss))))
39     (setf ss (list-sort ss))
40     (let ((cutoff (/ (cadar ss) 2))
41           (results-array '()))
42       (dolist (hit ss)
43         (if (> (cadr hit) cutoff)
44             (setf results-array (cons hit results-array))))
45       (reverse results-array))))

On thing to notice in this listing is lines 11 through 15 where I define a nested function list-sort that takes a list of sub-lists and sorts the sublists based on the second value (which is a number) in the sublists. I often nest functions when the “inner” functions are only used in the “outer” function.

Lines 2 through 9 define several local variables used in the outer function. The global variable categoryHashtables is a list of word weighting score hash tables, one for each category. The local variable category-score-accumulation-array is initialized to an array containing the number zero in each element and will be used to “keep score” of each category. The highest scored categories will be the return value for the outer function.

Lines 17 through 27 are two nested loops. The outer loop is over each word in the input word array. The inner loop is over the number of categories. The logic is simple: for each word check to see if it has a weighting score in each category’s word weighting score hash table and if it is, increment the matching category’s score.

The local variable ss is set to an empty list on line 28 and in the loop in lines 29 through 38 I am copying over categories and their scores when the score is over a threshold value of 0.01. We sort the list in ss on line 39 using the inner function and then return the categories with a score greater than the median category score.

Stemming Text

Stemming text is often used for information retrieval tasks. Stemming maps words to the root word yielding tokens that are often not legal words. For example “president” and “presidential” would both map to “presid” so searching for the token “presid” in a stemmed token list would match either word.

The Common Lisp stemming code in the file src/knowledgebooks_nlp.lisp was written by Steven M. Haflich and is based on based on the work of Martin Porter.

As we saw in a previous example the effects of stemming:

1 :TEXT #("President" "Bob" "Smith" "talked" "to" "Congress" "about" "the"
2         "economy" "and" "taxes")
3 :STEMS #("presid" "bob" "smith" "talk" "to" "congress" "about" "the"
4          "economi" "and" "tax"))

The top level function make-text-object stems all words in input text.

Detecting People’s Names and Place Names

The functions that support identifying people’s names and place names in text are:

  • find-names (words tags exclusion-list) – words is an array of strings for the words in text, tags are the parts of speech tags (from FastTag), and the exclusion list is a an array of words that you want to exclude from being considered as parts of people’s names. The list of found names records starting and stopping indices for names in the array words.
  • not-in-list-find-names-helper (a-list start end) – returns true if a found name is not already been added to a list for saving people’s names in text
  • find-places (words exclusion-list) – this is similar to find-names, but it finds place names. The list of found place names records starting and stopping indices for place names in the array words.
  • not-in-list-find-places-helper (a-list start end) – returns true if a found place name is not already been added to a list for saving place names in text
  • build-list-find-name-helper (v indices) – This converts lists of start/stop word indices to strings containing the names
  • find-names-places (txt-object) – this is the top level function that your application will call. It takes a defstruct text object as input and modifies the defstruct text by adding people’s and place names it finds in the text. You saw an example of this earlier in this chapter.

I will let you read the code and just list the top level function:

 1 (defun find-names-places (txt-object)
 2   (let* ((words (text-text txt-object))
 3 	 (tags (text-tags txt-object))
 4 	 (place-indices (find-places words nil))
 5 	 (name-indices (find-names words tags place-indices))
 6 	 (name-list
 7 	   (remove-duplicates
 8 	     (build-list-find-name-helper words name-indices) :test #'equal))
 9 	 (place-list
10 	   (remove-duplicates
11 	     (build-list-find-name-helper words place-indices) :test #'equal)))
12     (let ((ret '()))
13       (dolist (x name-list)
14 	(if (search " " x)
15 	    (setq ret (cons x ret))))
16       (setq name-list (reverse ret)))
17     (list
18      (remove-shorter-names name-list)
19      (remove-shorter-names place-list))))

In line 2 we are using the slot accessor text-text to fetch the array of word tokens from the text object. In lines 3, 4, and 5 we are doing the same for part of speech tags, place name indices in the words array, and person names indices in the words array.

In lines 6 through 11 we are using the function build-list-find-name-helper twice to construct the person names and place names as strings given the indices in the words array. We are also using the Common Lisp built-in function remove-duplicates to get rid of duplicate names.

In lines 12 through 16 we are discarding any persons names that do not contain a space, that is, only keep names that are at least two word tokens. Lines 17 through 19 define the return value for the function: a list of lists of people and place names using the function remove-shorter-names twice to remove shorter versions of the same names from the lists. For example, if we had two names “Mr. John Smith” and “John Smith” then we would want to drop the shorter name “John Smith” from the return list.

Summarizing Text

There are many applications for summarizing text. As an example, if you are writing a document management system you will certainly want to use something like Solr to provide search functionality. Solr will return highlighted matches in snippets of indexed document field values. Using summarization, when you add documents to a Solr (or other) search index you could create a new unindexed field that contains a document summary. Then when the users of your system see search results they will see the type of highlighted matches in snippets they are used to seeing in Google, Bing, or DuckDuckGo search results, and, they will see a summary of the document.

Sounds good? The problem to solve is getting good summaries of text and the technique used may have to be modified depending on the type of text you are trying to summarize. There are two basic techniques for summarization: a practical way that almost everyone uses, and an area of research that I believe has so far seen little practical application. The techniques are sentence extraction and abstraction of text into a shorter form by combining and altering sentences. We will use sentence extraction.

How do we choose which sentences in text to extract for the summary? The idea I had in 1999 was simple. Since I usually categorize text in my NLP processing pipeline why not use the words that gave the strongest evidence for categorizing text, and find the sentences with the largest number of these words. As a concrete example, if I categorize text as being “politics”, I identify the words in the text like “president”, “congress”, “election”, etc. that triggered the “politics” classification, and find the sentences with the largest concentrations of these words.

Summarization is something that you will probably need to experiment with depending on your application. My old summarization code contained a lot of special cases, blocks of commented out code, etc. I have attempted to shorten and simplify my old summarization code for the purposes of this book as much as possible and still maintain useful functionality.

The function for summarizing text is fairly simple because when the function summarize is called by the top level NLP library function make-text-object, the input text has already been categorized. Remember from the example at the beginning of the chapter that the category data looks like this:

1 :CATEGORY-TAGS (("news_politics.txt" 0.38268)
2                 ("news_economy.txt" 0.31182)
3                 ("news_war.txt" 0.20174))

This category data is saved in the local variable cats on line 4 of the following listing.

 1 (defun summarize (txt-obj)
 2   (let* ((words (text-text txt-obj))
 3          (num-words (length words))
 4          (cats (text-category-tags txt-obj))
 5          (sentence-count 0)
 6          best-sentences sentence (score 0))
 7     ;; loop over sentences:
 8     (dotimes (i num-words)
 9       (let ((word (svref words i)))
10         (dolist (cat cats)
11           (let* ((hash (gethash (car cat) categoryToHash))
12                  (value (gethash word hash)))
13             (if value
14                 (setq score (+ score (* 0.01 value (cadr cat)))))))
15         (push word sentence)
16         (if (or (equal word ".") (equal word "!") (equal word ";"))
17             (let ()
18               (setq sentence (reverse sentence))
19               (setq score (/ score (1+ (length sentence))))
20               (setq sentence-count (1+ sentence-count))
21               (format t "~%~A : ~A~%" sentence score)
22               ;; process this sentence:
23               (if (and
24                    (> score 0.4)
25                    (> (length sentence) 4)
26                    (< (length sentence) 30))
27                   (progn
28                     (setq sentence
29                           (reduce
30                            #'(lambda (x y) (concatenate 'string x " " y))
31                            (coerce sentence 'list)))
32                     (push (list sentence score) best-sentences)))
33               (setf sentence nil score 0)))))
34     (setf
35      best-sentences
36      (sort
37       best-sentences
38       #'(lambda (x y) (> (cadr x) (cadr y)))))
39     (if best-sentences
40         (replace-all
41          (reduce #'(lambda (x y) (concatenate 'string x " " y))
42                  (mapcar #'(lambda (x) (car x)) best-sentences))
43          " ." ".")
44         "<no summary>")))

The nested loops in lines 8 through 33 look a little complicated, so let’s walk through it. Our goal is to calculate an importance score for each word token in the input text and to then select a few sentences containing highly scored words. The outer loop is over the word tokens in the input text. For each word token we loop over the list of categories, looking up the current word in each category hash and incrementing the score for the current word token. As we increment the word token scores we also look for sentence breaks and save sentences.

The complicated bit of code in in lines 16 through 32 where I construct sentences and their scores, and store sentences with a score above a threshold value in the list best-sentences. After the two nested loops, in lines 34 through 44 we simply sort the sentences by score and select the “best” sentences for the summary. The extracted sentences are no longer in their original order, which can have strange effects, but I like seeing the most relevant sentences first.

Text Mining

Text mining in general refers to finding data in unstructured text. We have covered several text mining techniques in this chapter:

  • Named entity recognition - the NLP library covered in this chapter recognizes person and place entity names. I leave it as an exercise for you to extend this library to handle company and product names. You can start by collecting company and product names in the files src/data/names/names.companies and src/data/names/names.products and extend the library code.
  • Categorizing text - you can increase the accuracy of categorization by adding more weighted words/terms that support categories. If you are already using Java in the systems you build, I recommend the Apache OpenNLP library that is more accurate than the simpler “bag of words” approach I used in my Common Lisp NLP library. If you use Python, then I recommend that you also try the NLTK library.
  • Summarizing text.

In the next chapter I am going to cover another “data centric” topic: performing information gathering on the web. You will likely find some synergy between being able to use NLP to create structured data from unstructured text.

Information Gathering

This chapter covers information gathering on the web using data sources and general techniques that I have found useful. When I was planning this new book edition I had intended to also cover some basics for using the Semantic Web from Common Lisp, basically distilling some of the data from my previous book “Practical Semantic Web and Linked Data Applications, Common Lisp Edition” published in 2011. However since a free PDF is now available for that book I decided to just refer you to my previous work if you are interested in the Semantic Web and Linked Data. You can also find the Java edition of this previous book on my web site.

Gathering information from the web in realtime has some real advantages:

  • You don’t need to worry about storing data locally.
  • Information is up to date (depending on which web data resources you choose to use).

There are also a few things to consider:

  • Data on the web may have legal restrictions on its use so be sure to read the terms and conditions on web sites that you would like to use.
  • Authorship and validity of data may be questionable.

DBPedia Lookup Service

Wikipedia is a great source of information. As you may know, you can download a data dump of all Wikipedia data with or without version information and comments. When I want fast access to the entire Wikipedia set of English language articles I choose the second option and just get the current pages with no comments of versioning information. This is the direct download link for current Wikipedia articles. There are no comments or user pages in this GZIP file. This is not as much data as you might think, only about 9 gigabytes compressed or about 42 gigabytes uncompressed.

Wikipedia is a great resource to have on-hand but I am going to show you in this section how to access the Semantic Web version or Wikipedia, DBPedia using the DBPedia Lookup Service in the next code listing that shows the contents of the example file dbpedia-lookup.lisp:

 1 (ql:quickload :drakma)
 2 (ql:quickload :babel)
 3 (ql:quickload :s-xml)
 4 
 5 ;; utility from http://cl-cookbook.sourceforge.net/strings.html#manip:
 6 (defun replace-all (string part replacement &key (test #'char=))
 7   "Returns a new string in which all the occurrences of the part 
 8 is replaced with replacement."
 9   (with-output-to-string (out)
10     (loop with part-length = (length part)
11        for old-pos = 0 then (+ pos part-length)
12        for pos = (search part string
13                          :start2 old-pos
14                          :test test)
15        do (write-string string out
16                         :start old-pos
17                         :end (or pos (length string)))
18        when pos do (write-string replacement out)
19        while pos)))
20 
21 (defstruct dbpedia-data uri label description)
22 
23 (defun dbpedia-lookup (search-string)
24   (let* ((s-str (replace-all search-string " " "+"))
25          (s-uri 
26           (concatenate
27            'string
28            "http://lookup.dbpedia.org/api/search.asmx/KeywordSearch?QueryString="
29            s-str))
30          (response-body nil)
31          (response-status nil)
32          (response-headers nil)
33          (xml nil)
34          ret)
35     (multiple-value-setq
36         (response-body response-status response-headers)
37       (drakma:http-request
38        s-uri
39        :method :get
40        :accept "application/xml"))
41     ;; (print (list "raw response body as XML:" response-body))
42     ;;(print (list ("status:" response-status "headers:" response-headers)))
43     (setf xml
44           (s-xml:parse-xml-string
45            (babel:octets-to-string response-body)))
46     (dolist (r (cdr xml))
47       ;; assumption: data is returned in the order:
48       ;;   1. label
49       ;;   2. DBPedia URI for more information
50       ;;   3. description
51       (push
52        (make-dbpedia-data
53         :uri (cadr (nth 2 r))
54         :label (cadr (nth 1 r))
55         :description
56         (string-trim
57          '(#\Space #\NewLine #\Tab)
58          (cadr (nth 3 r))))
59        ret))
60     (reverse ret)))
61 
62 ;; (dbpedia-lookup "berlin")

I am only capturing the attributes for DBPedia URI, label and description in this example code. If you uncomment line 41 and look at the entire response body from the call to DBPedia Lookup, you can see other attributes that you might want to capture in your applications.

Here is a sample call to the function dbpedia-lookup (only some of the returned data is shown):

 1 * (load "dbpedia-lookup.lisp")
 2 *  (dbpedia-lookup "berlin")
 3 
 4 (#S(DBPEDIA-DATA
 5   :URI "http://dbpedia.org/resource/Berlin"
 6   :LABEL "Berlin"
 7   :DESCRIPTION
 8   "Berlin is the capital city of Germany and one of the 16 states of Germany.
 9    With a population of 3.5 million people, Berlin is Germany's largest city
10    and is the second most populous city proper and the eighth most populous
11    urban area in the European Union. Located in northeastern Germany, it is
12    the center of the Berlin-Brandenburg Metropolitan Region, which has 5.9
13    million residents from over 190 nations. Located in the European Plains,
14    Berlin is influenced by a temperate seasonal climate.")
15  ...)

Wikipedia, and the DBPedia linked data for of Wikipedia are great sources of online data. If you get creative, you will be able to think of ways to modify the systems you build to pull data from DPPedia. One warning: Semantic Web/Linked Data sources on the web are not available 100% of the time. If your business applications depend on having the DBPedia always available then you can follow the instructions on the DBPedia web site to install the service on one of your own servers.

Web Spiders

When you write web spiders to collect data from the web there are two things to consider:

  • Make sure you read the terms of service for web sites whose data you want to use. I have found that calling or emailing web site owners explaining how I want to use the data on their site usually works to get permission.
  • Make sure you don’t access a site too quickly. It is polite to wait a second or two between fetching pages and other assets from a web site.

We have already used the Drakma web client library in this book. See the files src/dbpedia-lookup.lisp (covered in the last section) and src/solr-client.lisp (covered in the Chapter on NoSQL). Paul Nathan has written library using Drakma to crawl a web site with an example to print out links as they are found. His code is available under the AGPL license at articulate-lisp.com/src/web-trotter.lisp and I recommend that as a starting point. The documentation is here.

I find it is sometimes easier during development to make local copies of a web site so that I don’t have to use excess resources from web site hosts. Assuming that you have the wget utility installed, you can mirror a site like this:

1 wget -m -w 2 http://knowledgebooks.com/
2 wget -mk -w 2 http://knowledgebooks.com/

Both of these examples have a two second delay between HTTP requests for resources. The option -m indicates to recursively follow all links on the web site. The -w 2 option delays for two seconds between requests. The option -mk converts URI references to local file references on your local mirror. The second example on line 2 is more convenient.

We covered reading from local files in the Chapter on Input and Output. One trick I use is to simply concatenate all web pages into one file. Assuming that you created a local mirror of a web site, cd to the top level directory and use something like this:

1 cd knowledgebooks.com
2 cat *.html */*.html > ../web_site.html

You can then open the file, search for text in in p, div, h1, etc. HTML elements to process an entire web site as one file.

Using Apache Nutch

Apache Nutch, like Solr, is built on Lucene search technology. I use Nutch as a “search engine in a box” when I need to spider web sites and I want a local copy with a good search index.

Nutch handles a different developer’s use case over Solr which we covered in the Chapter on NoSQL. As we saw, Solr is an effective tool for indexing and searching structured data as documents. With very little setup, Nutch can be set up to automatically keep an up to date index of a list of web sites, and optionally follow links to some desired depth from these “seed” web sites.

You can use the same Common Lisp client code that we used for Solr with one exception; you will need to change the root URI for the search service to:

1  http://localhost:8080/opensearch?query=

So the modified client code src/solr-client.lisp needs one line changed:

1 (defun do-search (&rest terms)
2   (let ((query-string (format nil "~{~A~^+AND+~}" terms)))
3    (cl-json:decode-json-from-string
4      (drakma:http-request
5        (concatenate 
6         'string
7         "http://localhost:8080/opensearch?query="
8         query-string
9         "&wt=json")))))

Early versions of Nutch were very simple to install and configure. Later versions of Nutch have been more complex, more performant, and have more services, but it will take you longer to get set up than earlier versions. If you just want to experiment with Nutch, you might want to start with an earlier version.

The OpenSearch.org web site contains many public OpenSearch services that you might want to try. If you want to modify the example client code in src/solr-client.lisp you should start with OpenSearch services that return JSON data and OpenSearch Community JSON formats web page is a good place to start. Some of the services on this web page like the New York Times service require that you sign up for a developer’s API key.

When I start writing an application that requires web data (no matter which programming language I am using) I start by finding services that may provide the type of data I need and do my initial development with a web browser with plugin support to nicely format XML and JSON data. I do a lot of exploring and take a lot of notes before I write any code.

Wrap Up

I tried to provide some examples and advice in this short chapter to show you that even though other languages like Ruby and Python have more libraries and tools for gathering information from the web, Common Lisp has good libraries for information gathering also and they are easily used via Quicklisp.

Using The CL Machine-Learning Library

The CL Machine-Learning (CLML) library was originally developed by MSI (NTT DATA Mathematical Systems Inc. in Japan) and is supported by many developers. You should visit the CLML web page and follow the installation directions and read about the project before using the examples in this chapter. However if you just want to quickly try the following CLML examples then you can install CLML using Quicklisp:

mkdir -p ~/quicklisp/local-projects
cd ~/quicklisp/local-projects
git clone https://github.com/mmaul/clml.git
sbcl --dynamic-space-size 2560
> (ql:quickload :clml :verbose t)

The installation will take a while to run but after installation using the libraries via quickload is fast.

Other resources for CLML are the tutorials and contributed extensions that include support for plotting (using several libraires) and for fetching data sets.

Although CLML is fairly portable we will be using SBCL and we need to increase the heap space when starting SBCL when we want to use the CLML library:

sbcl --dynamic-space-size 2560

Assuming that you have installed CLML in the ~quicklisp/local-projects directory, you can open the following documentation file in your web browser:

~/quicklisp/local-projects/clml/docs/clml-manual.html

This documentation lists the packages with some information for each package but realistically I keep the source code for CLML in an editor or IDE and read source code while writing code that uses CLML. I will show you with short examples how to use the KNN (K nearest neighbors) and SVM (support vector machines) APIs. We will not cover other useful CLML APIs like time series processing, Naive Bayes, PCA (principle component anaysis) and general matrix and tensor operations.

Even though the learning curve is a bit steep, CLML provides a lot of functionality for machine learning, dealing with time series data, and general matrix and tensor operations.

Using the CLML Data Loading and Access APIs

The CLML project uses several data sets and since the few that we will use are small files, they are included in the book’s repository in directory machine_learning_data under the src directory. The first few lines of labeled_cancer_training_data.csv are:

Cl.thickness,Cell.size,Cell.shape,Marg.adhesion,Epith.c.size,Bare.nuclei,Bl.crom\
atin,Normal.nucleoli,Mitoses,Class
5,4,4,5,7,10,3,2,1,benign
6,8,8,1,3,4,3,7,1,benign
8,10,10,8,7,10,9,7,1,malignant
2,1,2,1,2,1,3,1,1,benign

The first line in the CSV data files specifies names for each attribute with the name of the last column being “Class” which here takes on values benign or malignant. Later, the goal will be to create models that are constructed from training data and then make predictions of the “Class” of new input data. We will look at how to build and use machine learning models later but here we concentrate of reading and using input data.

The example file clml_data_apis.lisp shows how to open a file and loop over the values for each row:

 1 ;; note; run SBCL using: sbcl --dynamic-space-size 2560
 2 
 3 (ql:quickload '(:clml
 4                 :clml.hjs)) ; read data sets
 5 
 6 (defpackage #:clml-data-test
 7   (:use #:cl #:clml.hjs.read-data))
 8 
 9 (in-package #:clml-data-test)
10 
11 (defun read-data ()
12   (let ((train1
13          (clml.hjs.read-data:read-data-from-file
14           "./machine_learning_data/labeled_cancer_training_data.csv"
15           :type :csv
16           :csv-type-spec (append
17                            (make-list 9 :initial-element 'double-float)
18                            '(symbol)))))
19     (loop-over-and-print-data train1)))
20 
21 (defun loop-over-and-print-data (clml-data-set)
22   (print "Loop over and print a CLML data set:")
23   (let ((testdata (clml.hjs.read-data:dataset-points clml-data-set)))
24     (loop for td across testdata
25        do
26          (print td))))
27 
28 (read-data)

The function read-data defined in lines 11-19 uses the utility function clml.hjs.read-data:read-data-from-file to read a CSV (comma separated value) spreadsheet file from disk. The CSV file is expected to contain 10 columns (set in lines 17-18) with the first nine columns containing floating point values and the last column text data.

The function loop-over-and-print-data defined in lines 21-26 reads the CLML data set object, looping over each data sample (i.e., each row in the original spreadsheet file) and printing it.

Here is some output from loading this file:

 1 $ sbcl --dynamic-space-size 2560
 2 This is SBCL 1.3.16, an implementation of ANSI Common Lisp.
 3 More information about SBCL is available at <http://www.sbcl.org/>.
 4 
 5 SBCL is free software, provided as is, with absolutely no warranty.
 6 It is mostly in the public domain; some portions are provided under
 7 BSD-style licenses.  See the CREDITS and COPYING files in the
 8 distribution for more information.
 9 * (load "clml_data_apis.lisp")
10 
11 "Loop over and print a CLML data set:" 
12 #(5.0d0 4.0d0 4.0d0 5.0d0 7.0d0 10.0d0 3.0d0 2.0d0 1.0d0 |benign|) 
13 #(6.0d0 8.0d0 8.0d0 1.0d0 3.0d0 4.0d0 3.0d0 7.0d0 1.0d0 |benign|) 
14 #(8.0d0 10.0d0 10.0d0 8.0d0 7.0d0 10.0d0 9.0d0 7.0d0 1.0d0 |malignant|) 
15 #(2.0d0 1.0d0 2.0d0 1.0d0 2.0d0 1.0d0 3.0d0 1.0d0 1.0d0 |benign|) 

In the next section we will use the same cancer data training file, and another test data in the same format to cluster this cancer data into similar sets, one set for non-malignant and one for malignant samples.

K-Means Clustering of Cancer Data Set

We will now read the same University of Wisconsin cancer data set and cluster the input samples (one sample per row of the spreadsheet file) into similar classes. We will find after training a model that the data is separated into two clusters, representing non-malignant and malignant samples.

The function cancer-data-cluster-example-read-data defined in lines 33-47 is very simple to the function read-data in the last section except here we read in two data files: one for training and one for testing.

The function cluster-using-k-nn defined in lines 13-30 uses the training and test data objects to first train a model and then to test it with test data that was previously used for training. Notice how we call this function in line 47: the first two arguments are the two data set objects, the third is the string “Class” that is the label for the 10th column of the original spreadsheet CSV files, and the last argument is the type of distance measurement used to compare two data samples (i.e., comparing any two rows of the training CSV data file).

 1 ;; note; run SBCL using: sbcl --dynamic-space-size 2560
 2 
 3 (ql:quickload '(:clml
 4                 :clml.hjs ; utilities
 5                 :clml.clustering))
 6 
 7 (defpackage #:clml-knn-cluster-example1
 8   (:use #:cl #:clml.hjs.read-data))
 9 
10 (in-package #:clml-knn-cluster-example1)
11 
12 ;; folowing is derived from test code in CLML:
13 (defun cluster-using-k-nn (test train objective-param-name  manhattan)
14   (let (original-data-column-length)
15     (setq original-data-column-length
16           (length (aref (clml.hjs.read-data:dataset-points train) 0)))
17     (let* ((k 5)
18            (k-nn-estimator
19             (clml.nearest-search.k-nn:k-nn-analyze train
20               k
21               objective-param-name :all
22               :distance manhattan :normalize t)))
23       (loop for data across
24           (dataset-points
25             (clml.nearest-search.k-nn:k-nn-estimate k-nn-estimator test))
26          if (equal (aref data 0) (aref data original-data-column-length))
27          do
28            (format t "Correct: ~a~%" data)
29          else do
30            (format t "Wrong:   ~a~%" data)))))
31 
32 ;; folowing is derived from test code in CLML:
33 (defun cancer-data-cluster-example-read-data ()
34   (let ((train1
35          (clml.hjs.read-data:read-data-from-file
36           "./machine_learning_data/labeled_cancer_training_data.csv"
37           :type :csv
38           :csv-type-spec (append (make-list 9 :initial-element 'double-float)
39                                  '(symbol))))
40         (test1
41          (clml.hjs.read-data:read-data-from-file
42           "./machine_learning_data/labeled_cancer_test_data.csv"
43           :type :csv
44           :csv-type-spec (append (make-list 9 :initial-element 'double-float)
45                                  '(symbol)))))
46     ;;(print test1)
47     (print (cluster-using-k-nn test1 train1 "Class" :double-manhattan))))
48 
49 (cancer-data-cluster-example-read-data)

The following listing shows the output from running the last code example:

 1 Number of self-misjudgement : 13
 2 Correct: #(benign 5.0d0 1.0d0 1.0d0 1.0d0 2.0d0 1.0d0 3.0d0 1.0d0 1.0d0 benign)
 3 Correct: #(benign 3.0d0 1.0d0 1.0d0 1.0d0 2.0d0 2.0d0 3.0d0 1.0d0 1.0d0 benign)
 4 Correct: #(benign 4.0d0 1.0d0 1.0d0 3.0d0 2.0d0 1.0d0 3.0d0 1.0d0 1.0d0 benign)
 5 Correct: #(benign 1.0d0 1.0d0 1.0d0 1.0d0 2.0d0 10.0d0 3.0d0 1.0d0 1.0d0 benign)
 6 Correct: #(benign 2.0d0 1.0d0 1.0d0 1.0d0 2.0d0 1.0d0 1.0d0 1.0d0 5.0d0 benign)
 7 Correct: #(benign 1.0d0 1.0d0 1.0d0 1.0d0 1.0d0 1.0d0 3.0d0 1.0d0 1.0d0 benign)
 8 Wrong:   #(benign 5.0d0 3.0d0 3.0d0 3.0d0 2.0d0 3.0d0 4.0d0 4.0d0 1.0d0
 9            malignant)
10 Correct: #(malignant 8.0d0 7.0d0 5.0d0 10.0d0 7.0d0 9.0d0 5.0d0 5.0d0 4.0d0
11            malignant)
12 Correct: #(benign 4.0d0 1.0d0 1.0d0 1.0d0 2.0d0 1.0d0 2.0d0 1.0d0 1.0d0 benign)
13 Correct: #(malignant 10.0d0 7.0d0 7.0d0 6.0d0 4.0d0 10.0d0 4.0d0 1.0d0 2.0d0
14            malignant)
15  ...

SVM Classification of Cancer Data Set

We will now reuse the same cancer data set but use a different way to classify data into non-malignant and malignant categories: Support Vector Machines (SVM). SVMs are linear classifiers which means that they work best when data is linearly separable. In the case of the cancer data, there are nine dimensions of values that (hopefully) predict one of the two output classes (or categories). If we think of the first 9 columns of data as defining a 9-dimensional space, then SVM will work well when a 8-dimensional hyperplane separates the samples into the two output classes (categories).

To make this simpler to visualize, if we just had two input columns, that defines a two-dimensional space, and if a straight line can separate most of the examples into the two output categories, then the data is linearly separable so SVM is a good technique to use. The SVM algorithm is effectively determining the parameters defining this one-dimensional line (or in the cancer data case, the 9-dimensional hyperspace).

What if data is not linearly separable? Then use the backpropagation neural network code in the chapter “Backpropagation Neural Networks” or the deep learning code in the chapter “Using Armed Bear Common Lisp With DeepLearning4j” to create a model.

SVM is very efficient so it often makes sense to first try SVM and if trained models are not accurate enough then use neural networks (including deep learning).

The following listing of file clml_svm_classifier.lisp shows how to read data, build a model and evaluate the model with different test data. In line 15 we use the function clml.svm.mu:svm that requires the type of kernel function to use, the training data, and testing data. Just for reference, we usually use Gaussian kernel functions for processing numeric data and linear kernel functions for handling text in natural language processing applications. Here we use a Gaussian kernel.

The function cancer-data-svm-example-read-data defined on line 40 differs from how we read and processed data earlier because we need to separate out the positive and negative training examples. The data is split in the lexically scoped function in lines 42-52. The last block of code in lines 54-82 is just top-level test code that gets executed when the file clml_svm_classifier.lisp is loaded.

 1 ;; note; run SBCL using: sbcl --dynamic-space-size 2560
 2 
 3 (ql:quickload '(:clml
 4                 :clml.hjs ; utilities
 5                 :clml.svm))
 6 
 7 (defpackage #:clml-svm-classifier-example1
 8   (:use #:cl #:clml.hjs.read-data))
 9 
10 (in-package #:clml-svm-classifier-example1)
11 
12 (defun svm-classifier-test (kernel train test)
13   "train and test are lists of lists, with first elements being negative
14    samples and the second elements being positive samples"
15   (let ((decision-function (clml.svm.mu:svm kernel (cadr train) (car train)))
16         (correct-positives 0)
17         (wrong-positives 0)
18         (correct-negatives 0)
19         (wrong-negatives 0))
20     ;; type: #<CLOSURE (LAMBDA (CLML.SVM.MU::Z) :IN CLML.SVM.MU::DECISION)>
21     (print decision-function)
22     (princ "***** NEGATIVE TESTS: calling decision function:")
23     (terpri)
24     (dolist (neg (car test))  ;; negative test examples
25       (let ((prediction (funcall decision-function neg)))
26         (print prediction)
27         (if prediction (incf wrong-negatives) (incf correct-negatives))))
28     (princ "***** POSITIVE TESTS: calling decision function:")
29     (terpri)
30     (dolist (pos (cadr test)) ;; positive test examples
31       (let ((prediction (funcall decision-function pos)))
32         (print prediction)
33         (if prediction (incf correct-positives) (incf wrong-positives))))
34     (format t "Number of correct negatives ~a~%" correct-negatives)
35     (format t "Number of wrong negatives ~a~%" wrong-negatives)
36     (format t "Number of correct positives ~a~%" correct-positives)
37     (format t "Number of wrong positives ~a~%" wrong-positives)))
38 
39 
40 (defun cancer-data-svm-example-read-data ()
41 
42   (defun split-positive-negative-cases (data)
43     (let ((negative-cases '())
44           (positive-cases '()))
45       (dolist (d data)
46         ;;(print (list "*  d=" d))
47         (if (equal (symbol-name (first (last d))) "benign")
48             (setf negative-cases
49                   (cons (reverse (cdr (reverse d))) negative-cases))
50             (setf positive-cases
51                   (cons (reverse (cdr (reverse d))) positive-cases))))
52       (list negative-cases positive-cases)))
53 
54   (let* ((train1
55           (clml.hjs.read-data:read-data-from-file
56            "./machine_learning_data/labeled_cancer_training_data.csv"
57            :type :csv
58            :csv-type-spec (append (make-list 9 :initial-element 'double-float)
59                                   '(symbol))))
60          (train-as-list
61           (split-positive-negative-cases
62            (coerce
63             (map 'list
64                  #'(lambda (x) (coerce x 'list))
65                  (coerce (clml.hjs.read-data:dataset-points train1) 'list))
66             'list)))
67          (test1
68           (clml.hjs.read-data:read-data-from-file
69            "./machine_learning_data/labeled_cancer_test_data.csv"
70            :type :csv
71            :csv-type-spec (append (make-list 9 :initial-element 'double-float)
72                                   '(symbol))))
73          (test-as-list
74           (split-positive-negative-cases
75            (coerce
76             (map 'list
77                  #'(lambda (x) (coerce x 'list))
78                  (coerce (clml.hjs.read-data:dataset-points test1) 'list))
79             'list))))
80 
81     ;; we will use a gaussian kernel for numeric data.
82     ;; note: for text classification, use a clml.svm.mu:+linear-kernel+
83     (svm-classifier-test
84      (clml.svm.mu:gaussian-kernel 2.0d0)
85      train-as-list test-as-list)))
86 
87 (cancer-data-svm-example-read-data)

The sample code prints the prediction values for the test data which I will not show here. Here are the last four lines of output showing the cumulative statistics for the test data:

1 Number of correct negatives 219
2 Number of wrong negatives 4
3 Number of correct positives 116
4 Number of wrong positives 6

CLML Wrap Up

The CLML machine learning library is under fairly active development and I showed you enough to get started: understanding the data APIs and examples for KNN clustering and SVM classification.

A good alternative to CLML is MGL that supports backpropagation neural networks, boltzmann machines, and gaussian processes.

In the next two chapters we continue with the topic of machine learning with backpropagation andf Hopfield neural networks.

Backpropagation Neural Networks

Let’s start with an overview of how these networks work and then fill in more detail later. Backpropagation networks are trained by applying training inputs to the network input layer, propagate values through the network to the output neurons, compare the errors (or differences) between these propagated output values and the training data output values. These output errors are backpropagated though the network and the magnitude of backpropagated errors are used to adjust the weights in the network.

We will use the following diagram to make this process more clear. There are four weights in this very simple network:

  • W1,1 is the floating point number representing the connection strength between input_neuron1 and output_neuron1
  • W2,1 connects input_neuron2 to output_neuron1
  • W1,2 connects input_neuron1 to output_neuron2
  • W2,2 connects input_neuron2 to output_neuron2
Understanding how connection weights connect neurons in adjacent layers
Understanding how connection weights connect neurons in adjacent layers

Before any training the weight values are all small random numbers.

Consider a training data element where the input neurons have values [0.1, 0.9] and the desired output neuron values are [0.9 and 0.1], that is flipping the input values. If the propagated output values for the current weights are [0.85, 0.5] then the value of the first output neuron has a small error abs(0.85 - 0.9) which is 0.05. However the propagated error of the second output neuron is high: abs(0.5 - 0.1) which is 0.4. Informally we see that the weights feeding input output neuron 1 (W1,1 and W2,1) don’t need to be changed much but the neuron that feeding input neuron 2 (W1,2 and W2,2) need modification (the value of W2,2 is too large).

Of course, we would never try to manually train a network like this but it is important to have at least an informal understanding of how weights connect the flow of value (we will call this activation value later) between neurons.

In this neural network see in the first figure we have four weights connecting the input and output neurons. Think of these four weghts forming a four-dimensional space where the range in each dimension is constrained to small positive and negative floating point values. At any point in this “weight space”, the numeric values of the weights defines a model that maps the inputs to the outputs. The error seen at the output neurons is accumuated for each training example (applied to the input neurons). The training process is finding a point in this four-dimensional space that has low errors summed across the training data. We will use gradient descent to start with a random point in the four-dimensional space (i.e., an initial random set of weights) and move the point towards a local minimum that represents the weights in a model that is (hopefully) “good enough” at representing the training data.

This process is simple enough but there are a few practical considerations:

  • Sometimes the accumalated error at a local minimum is too large even after many training cycles and it is best to just restart the training process with new random weights.
  • If we don’t have enough training data then the network may have enough memory capacity to memorize the training examples. This is not what we want: we want a model with just enough memory capacity (as represented by the number of weights) to form a generalized predictive model, but so specific that is just memorizes the training examples. The solution is to start with small networks (few hidden neurons) and increase the number of neurons until the training data can be learned. In general, having a lot of training data is good and it is also good to use as small of a network as possible.

In practice using backpropagation networks is an iterative process of experimenting with the size of a network.

In the example program (in the file backprop_neural_network.lisp) we use the plotting library developed earlier to visualize neuron activation and connecting weight values while the network trains.

The following three screen shots from running the function test3 defined at the bottom of the file backprop_neural_network.lisp illustrate the process of starting with random weights, getting random outputs during initial training, and as delta weights are used to adjust the weights in a network, then the training examples are learned:

At the start of the trainign run with random weights and large delta weights
At the start of the trainign run with random weights and large delta weights

In the last figure the initial weights are random so we get random mid-range values at the output neurons.

The trained weights start to produce non-random output
The trained weights start to produce non-random output

As we start to train the network, adjusting the weights, we start to see variation in the output neurons as a function of what the inputs are.

After training many cycles the training examples are learned, with only small output errors
After training many cycles the training examples are learned, with only small output errors

In the last figure the network is trained sufficiently well to map inputs [0, 0, 0, 1] to output values that are approximately [0.8, 0.2, 0.2, 0.3] which is close to the expected value [1, 0, 0, 0].

The example source file backprop_neural_network.lisp is long so we will only look at the more interesting parts here. Specifically we will not look at the code to plot neural networks using plotlib.

The activation values of individual neurons are limited to the range [0, 1] by first calculating their values based on the sum activation values of neurons in the previous layer times the values of the connecting weights and then using the Sigmoid function to map the sums to the desired range. The Sigmoid function and the derivative of the Sigmoid function (dSigmoid) look like:

Sigmoid and Derivative of the Sigmid Functions
Sigmoid and Derivative of the Sigmid Functions

Here are the definitions of these functions:

(defun Sigmoid (x)
  (/ 1.0 (+ 1.0 (exp (- x)))))

(defun dSigmoid (x)
  (let ((temp (Sigmoid x)))
    (* temp (- 1.0 temp)))

The function NewDeltaNetwork creates a new neual network object. This code allocates storage for input, hidden, output layers (I sometimes refer to neuron layers as “slabs”), and the connection weights. Connection weights are initialized to small random values.

 1 ; (NewDeltaNetwork sizeList)
 2 ;       Args:   sizeList = list of sizes of slabs. This also defines
 3 ;                          the number of slabs in the network.
 4 ;                          (e.g.,  '(10 5 4) ==> a 3-slab network with 10
 5 ;                           input neurons, 5 hidden neurons, and 4 output
 6 ;                           neurons).
 7 ;
 8 ;       Returned value = a list describing the network:
 9 ;          (nLayers sizeList
10 ;           (activation-array[1] .. activation-array[nLayers])
11 ;           (weight-array[2] .. weight-array[nLayers])
12 ;           (sum-of-products[2] .. sum-of-products[nLayers[nLayers])
13 ;           (back-prop-error[2] .. back-prop-error[nLayers]))
14 ;           (old-delta-weights[2] .. for momentum term
15 
16                                        :initial-element 0.0))
17            (reverse old-dw-list)))
18 
19     ;;
20      ;  Initialize values for all activations:
21      ;;
22     (mapc
23      (lambda (x)
24         (let ((num (array-dimension x 0)))
25           (dotimes (n num)
26             (setf (aref x n) (frandom 0.01 0.1)))))
27      a-list)
28 
29     ;;
30      ;  Initialize values for all weights:
31      ;;
32     (mapc
33      (lambda (x)
34         (let ((numI (array-dimension x 0))
35               (numJ (array-dimension x 1)))
36           (dotimes (j numJ)
37             (dotimes (i numI)
38               (setf (aref x i j) (frandom -0.5 0.5))))))
39      w-list)
40     (list numLayers sizeList a-list s-list w-list dw-list
41           d-list old-dw-list alpha beta)))

In the following listing the function DeltaLearn processes one pass through all of the training data. Function DeltaLearn is called repeatedly until the return valuen is below a desired error threshold. The main loop over each training example is implemented in lines 69-187. Inside this outer loop there are two phases of training for each training example: a forward pass propagating activation from the input neurons to the output neurons via any hidden layers (lines 87-143) and then the weight correcting backpropagation of output errors while making small adjustments to weights (lines 148-187):

  1 ;;
  2  ;  Utility function for training a delta rule neural network.
  3  ;  The first argument is the name of an output PNG plot file
  4  ;  and a nil value turns off plotting the network during training.
  5  ;  The second argument is a network definition (as returned from
  6  ;  NewDeltaNetwork), the third argument is a list of training
  7  ;  data cases (see the example test functions at the end of this
  8  ;  file for examples.
  9  ;;
 10 
 11 (defun DeltaLearn (plot-output-file-name
 12 		   netList trainList)
 13   (let ((nLayers (car netList))
 14         (sizeList (cadr netList))
 15         (activationList (caddr netList))
 16         (sumOfProductsList (car (cdddr netList)))
 17         (weightList (cadr (cdddr netList)))
 18         (deltaWeightList (caddr (cdddr netList)))
 19         (deltaList (cadddr (cdddr netList)))
 20         (oldDeltaWeightList (cadddr (cdddr (cdr netList))))
 21         (alpha (cadddr (cdddr (cddr netList))))
 22         (beta (cadddr (cdddr (cdddr netList))))
 23         (inputs nil)
 24         (targetOutputs nil)
 25         (iDimension nil)
 26         (jDimension nil)
 27         (iActivationVector nil)
 28         (jActivationVector nil)
 29         (n nil)
 30         (weightArray nil)
 31         (sumOfProductsArray nil)
 32         (iDeltaVector nil)
 33         (jDeltaVector nil)
 34         (deltaWeightArray nil)
 35         (oldDeltaWeightArray nil)
 36         (sum nil)
 37         (iSumOfProductsArray nil)
 38         (error nil)
 39         (outputError 0)
 40         (delta nil)
 41         (eida nil)
 42         (inputNoise 0))
 43 
 44     ;;
 45      ; Zero out deltas:
 46      ;;
 47     (dotimes (n (- nLayers 1))
 48       (let* ((dw (nth n deltaList))
 49              (len1 (array-dimension dw 0)))
 50         (dotimes (i len1)
 51           (setf (aref dw i) 0.0))))
 52 
 53     ;;
 54      ; Zero out delta weights:
 55      ;;
 56     (dotimes (n (- nLayers 1))
 57       (let* ((dw (nth n deltaWeightList))
 58              (len1 (array-dimension dw 0))
 59              (len2 (array-dimension dw 1)))
 60         (dotimes (i len1)
 61           (dotimes (j len2)
 62             (setf (aref dw i j) 0.0)))))
 63 
 64     (setq inputNoise *delta-default-input-noise-value*)
 65 
 66     ;;
 67      ;  Main loop on training examples:
 68      ;;
 69     (dolist (tl trainList)
 70 
 71       (setq inputs (car tl))
 72       (setq targetOutputs (cadr tl))
 73 
 74       (if *delta-rule-debug-flag*
 75         (print (list "Current targets:" targetOutputs)))
 76 
 77       (setq iDimension (car sizeList)) ; get the size of the input slab
 78       (setq iActivationVector (car activationList)) ; input activations
 79       (dotimes (i iDimension) ; copy training inputs to input slab
 80         (setf
 81          (aref iActivationVector i)
 82          (+ (nth i inputs) (frandom (- inputNoise) inputNoise))))
 83       ;;
 84        ; Propagate activation through all of the slabs:
 85        ;;
 86       (dotimes (n-1 (- nLayers 1))  ; update layer i to layer flowing to layer j
 87         (setq n (+ n-1 1))
 88         (setq jDimension (nth n sizeList)) ; get the size of the j'th layer
 89         (setq jActivationVector (nth n activationList)) ; activation  for slab j
 90         (setq weightArray (nth n-1 weightList))
 91         (setq sumOfProductsArray (nth n-1 sumOfProductsList))
 92         (dotimes (j jDimension) ; process each neuron in slab j
 93           (setq sum 0.0) ; init sum of products to zero
 94           (dotimes (i iDimension) ; activation from neurons in previous slab
 95             (setq
 96              sum
 97              (+ sum (* (aref weightArray i j) (aref iActivationVector i)))))
 98           (setf (aref sumOfProductsArray j) sum) ; save sum of products
 99           (setf (aref jActivationVector j) (Sigmoid sum)))
100         (setq iDimension jDimension)     ; reset index for next slab pair
101         (setq iActivationVector jActivationVector))
102       ;;
103        ; Activation is  spread through the network and sum of products
104        ; calculated. Now modify the weights in the network using back
105        ; error propagation. Start by calculating the error signal for
106        ; each neuron in the output layer:
107        ;;
108       (setq jDimension (nth (- nLayers 1) sizeList)) ; size of last layer
109       (setq jActivationVector (nth (- nLayers 1) activationList))
110       (setq jDeltaVector (nth (- nLayers 2) deltaList))
111       (setq sumOfProductsArray (nth (- nLayers 2) sumOfProductsList))
112       (setq outputError 0)
113       (dotimes (j jDimension)
114         (setq delta (- (nth j targetOutputs) (aref jActivationVector j)))
115         (setq outputError (+ outputError (abs delta)))
116         (setf
117          (aref jDeltaVector j)
118          (+
119           (aref jDeltaVector j)
120           (* delta (dSigmoid (aref sumOfProductsArray j))))))
121       ;;
122        ; Now calculate the backpropagated error signal for all hidden slabs:
123        ;;
124       (dotimes (nn (- nLayers 2))
125         (setq n (- nLayers 3 nn))
126         (setq iDimension (nth (+ n 1) sizeList))
127         (setq iSumOfProductsArray (nth n sumOfProductsList))
128         (setq iDeltaVector (nth n deltaList))
129         (dotimes (i iDimension)
130           (setf (aref iDeltaVector i) 0.0))
131         (setq weightArray (nth (+ n 1) weightList))
132         (dotimes (i iDimension)
133           (setq error 0.0)
134           (dotimes (j jDimension)
135             (setq error
136                   (+ error (* (aref jDeltaVector j) (aref weightArray i j)))))
137           (setf
138            (aref iDeltaVector i)
139            (+
140             (aref iDeltaVector i)
141             (* error (dSigmoid (aref iSumOfProductsArray i))))))
142         (setq jDimension iDimension)
143         (setq jDeltaVector iDeltaVector))
144 
145       ;;
146        ; Update all delta weights in the network:
147        ;;
148       (setq iDimension (car sizeList))
149       (dotimes (n (- nLayers 1))
150         (setq iActivationVector (nth n activationList))
151         (setq jDimension (nth (+ n 1) sizeList))
152         (setq jDeltaVector (nth n deltaList))
153         (setq deltaWeightArray (nth n deltaWeightList))
154         (setq weightArray (nth n weightList))
155         (setq eida (nth n eidaList))
156 
157         (dotimes (j jDimension)
158           (dotimes (i iDimension)
159             (setq delta (* eida (aref jDeltaVector j) (aref iActivationVector i)\
160 ))
161             (setf
162              (aref DeltaWeightArray i j)
163              (+ (aref DeltaWeightArray i j) delta)))) ; delta weight changes
164 
165         (setq iDimension jDimension))
166 
167     ;;
168      ; Update all weights in the network:
169      ;;
170     (setq iDimension (car sizeList))
171     (dotimes (n (- nLayers 1))
172       (setq iActivationVector (nth n activationList))
173       (setq jDimension (nth (+ n 1) sizeList))
174       (setq jDeltaVector (nth n deltaList))
175       (setq deltaWeightArray (nth n deltaWeightList))
176       (setq oldDeltaWeightArray (nth n oldDeltaWeightList))
177       (setq weightArray (nth n weightList))
178       (dotimes (j jDimension)
179         (dotimes (i iDimension)
180           (setf
181            (aref weightArray i j)
182            (+ (aref weightArray i j)
183               (* alpha (aref deltaWeightArray i j))
184               (* beta  (aref oldDeltaWeightArray i j))))
185            (setf (aref oldDeltaWeightArray i j) ; save current delta weights
186                  (aref deltaWeightArray i j)))) ; ...for next momentum term.
187       (setq iDimension jDimension))
188 
189     (if plot-output-file-name
190         (DeltaPlot netList plot-output-file-name)))
191 
192     (/ outputError jDimension)))

The function DeltaRecall in te next listing can be used with a trained network to calculate outputs for new input values:

 1 ;;
 2  ;  Utility for using a trained neural network in the recall mode.
 3  ;  The first argument to this function is a network definition (as
 4  ;  returned from NewDeltaNetwork) and the second argument is a list
 5  ;  of input neuron activation values to drive through the network.
 6  ;  The output is a list of the calculated activation energy for
 7  ;  each output neuron.
 8  ;;
 9 (defun DeltaRecall (netList inputs)
10   (let ((nLayers (car netList))
11         (sizeList (cadr netList))
12         (activationList (caddr netList))
13         (weightList (cadr (cdddr netList)))
14         (iDimension nil)
15         (jDimension nil)
16         (iActivationVector nil)
17         (jActivationVector nil)
18         (n nil)
19         (weightArray nil)
20         (returnList nil)
21         (sum nil))
22     (setq iDimension (car sizeList)) ; get the size of the input slab
23     (setq iActivationVector (car activationList)) ; get input activations
24     (dotimes (i iDimension) ; copy training inputs to input slab
25       (setf (aref iActivationVector i) (nth i inputs)))
26     (dotimes (n-1 (- nLayers 1))  ; update layer j to layer i
27       (setq n (+ n-1 1))
28       (setq jDimension (nth n sizeList)) ; get the size of the j'th layer
29       (setq jActivationVector (nth n activationList)) ; activation for slab j
30       (setq weightArray (nth n-1 weightList))
31       (dotimes (j jDimension) ; process each neuron in slab j
32         (setq sum 0.0) ; init sum of products to zero
33         (dotimes (i iDimension) ; get activation from each neuron in last slab
34           (setq
35            sum
36            (+ sum (* (aref weightArray i j) (aref iActivationVector i)))))
37         (if *delta-rule-debug-flag*
38           (print (list "sum=" sum)))
39         (setf (aref jActivationVector j) (Sigmoid sum)))
40       (setq iDimension jDimension) ; get ready for next slab pair
41       (setq iActivationVector jActivationVector))
42       (dotimes (j jDimension)
43         (setq returnList (append returnList (list (aref jActivationVector j)))))
44       returnList))

We saw three output plots earlier that were produced during a training run using the following code:

 1 (defun test3 (&optional (restart 'yes) &aux RMSerror) ; three layer network
 2   (if
 3     (equal restart 'yes)
 4     (setq temp (newdeltanetwork '(5 4 5))))
 5   (dotimes (ii 3000)
 6     (let ((file-name
 7      (if (equal (mod ii 400) 0)
 8          (concatenate 'string "output_plot_" (format nil "~12,'0d" ii) ".png")
 9          nil)))
10       (setq
11        RMSerror
12        (deltalearn
13           file-name temp
14           '(((1 0 0 0 0) (0 1 0 0 0))
15             ((0 1 0 0 0) (0 0 1 0 0))
16             ((0 0 1 0 0) (0 0 0 1 0))
17             ((0 0 0 1 0) (0 0 0 0 1))
18             ((0 0 0 0 1) (1 0 0 0 0)))))
19       (if (equal (mod ii 50) 0) ;; print error out every 50 cycles
20         (progn
21           (princ "....training cycle \#")
22           (princ ii)
23           (princ " RMS error = ")
24           (princ RMSerror)
25           (terpri))))))

Here the function test3 defines training data for a very small test network for a moderately difficult function to learn: to rotate the values in the input neurons to the right, wrapping around to the first neuron. The start of the main loop in line calls the training function 3000 times, creating a plot of the network every 400 times through the main loop.

Backpropagation networks have been used sucessfully in production since for abut 25 years. In the next chapter we will look at a less practical type of network (Hopfield networks) that are still interesting because the in sme sense model how our brains work. In the final chapter we will look at deep lerning neural networks.

Hopfield Neural Networks

A Hopfield network (named after John Hopfield) is a recurrent network since the flow of activation through the network has loops. These networks are trained by applying input patterns and letting the network settle in a state that stores the input patterns.

The example we look at recognizes patterns that are similar to the patterns seen in training examples and maps input patterns to a similar training input pattern. The following figure shows output from the example program showing an original training pattern, a similar pattern with one cell turned on and onther off, and the reconstructed pattern:

To be clear, we have taken one of the original input patterns the network has learned, slightly altered it, and applied it as input to the network. After cycling the network, the slightly scrambled input pattern we just applied will (hopefully) be used as an associative memory key, look up the original pattern, and rewrite to input values with the original learned pattern. These Hopfield networks are very different than backpropagation networks: neuron activation are forced to values of -1 or +1 and not be differentiable slowly changing values) and there are no separate output neurons.

The next example has the values of three cells modified from the original and the original pattern is still reconstructed correctly:

This last example has four of the original cells modified:

The following example program shows a type of content-addressable memory. After a Hopfield network learns a set of input patterns then it can reconstruct the original paterns when shown similar patterns. This reconstruction is not always perfecrt.

The following function Hopfield-Init (in file Hopfield_neural_network.lisp) is passed a list of lists of training examples that will be remembered in the network. This function returns a list containing the data defining a Hopfield neural network. All data for the network is encapsulated in the list returned by this function, so multiple Hopfield neural networks can be used in an application program.

In lines 9-12 we allocate global arrays for data storage and in lines 14-18 the training data is copied.

The inner function adjustInput on lines 20-29 adjusts data values to values of -1.0 or +1.0. In lines 31-33 we are initializing all of the weights in the Hopfield network to zero.

The last nested loop, on lines 35-52, calculates the autocorrelation weight matrix from the input test patterns.

On lines 54-56, the function returns a representation of the Hopfield network that will be used later in the function HopfieldNetRecall to find the most similar “remembered” pattern given a new (fresh) input pattern.

 1 (defun Hopfield-Init (training-data
 2                       &aux temp *num-inputs* *num-training-examples*
 3                            *training-list* *inputCells* *tempStorage*
 4                            *HopfieldWeights*)
 5 
 6   (setq *num-inputs* (length (car training-data)))
 7   (setq *num-training-examples* (length training-data))
 8 
 9   (setq *training-list* (make-array (list *num-training-examples* *num-inputs*)))
10   (setq *inputCells* (make-array (list *num-inputs*)))
11   (setq *tempStorage* (make-array (list *num-inputs*)))
12   (setq *HopfieldWeights* (make-array (list *num-inputs* *num-inputs*)))
13 
14   (dotimes (j *num-training-examples*) ;; copy training data
15     (dotimes (i *num-inputs*)
16       (setf
17        (aref *training-list* j i)
18        (nth i (nth j training-data)))))
19 
20   (defun adjustInput (value)  ;; this function is lexically scoped
21     (if (< value 0.1)
22       -1.0
23       +1.0))
24 
25   (dotimes (i *num-inputs*) ;; adjust training data
26     (dotimes (n *num-training-examples*)
27       (setf
28        (aref *training-list* n i)
29        (adjustInput (aref *training-list* n i)))))
30 
31   (dotimes (i *num-inputs*) ;; zero weights
32     (dotimes (j *num-inputs*)
33       (setf (aref *HopfieldWeights* i j) 0)))
34 
35   (dotimes (j-1 (- *num-inputs* 1)) ;; autocorrelation weight matrix
36     (let ((j (+ j-1 1)))
37       (dotimes (i j)
38         (dotimes (s *num-training-examples*)
39           (setq temp
40                 (truncate
41                  (+
42                   (*  ;; 2 if's truncate values to -1 or 1:
43                    (adjustInput (aref *training-list* s i))
44                    (adjustInput (aref *training-list* s j)))
45                   (aref *HopfieldWeights* i j))))
46           (setf (aref *HopfieldWeights* i j) temp)
47           (setf (aref *HopfieldWeights* j i) temp)))))
48   (dotimes (i *num-inputs*)
49     (setf (aref *tempStorage* i) 0)
50     (dotimes (j i)
51       (setf (aref *tempStorage* i)
52             (+ (aref *tempStorage* i) (aref *HopfieldWeights* i j)))))
53 
54   (list ;; return the value of the Hopfield network data object
55    *num-inputs* *num-training-examples* *training-list*
56    *inputCells* *tempStorage* *HopfieldWeights*))

The following function HopfieldNetRecall iterates the network to let it settle in a stable pattern which will (we hope) be the original training pattern most closely resembling the noisy test pattern.

The inner (lexically scoped) function deltaEnergy defined on lines 9-12 calculates a change in energy from old input values and the autocorrelation weight matrix. The main code uses the inner functions to iterate over the input cells, possibly modifying the cell at index i delta energy is greater than zero. Remember that the lexically scoped inner functions have access to the variables for the number of inputs, the number of training examples, the list of training examples, the input cell values, tempoary storage, and the Hopfield network weights.

 1 (defun HopfieldNetRecall (aHopfieldNetwork numberOfIterations)
 2   (let ((*num-inputs* (nth 0 aHopfieldNetwork))
 3         (*num-training-examples*  (nth 1 aHopfieldNetwork))
 4         (*training-list* (nth 2 aHopfieldNetwork))
 5         (*inputCells* (nth 3 aHopfieldNetwork))
 6         (*tempStorage* (nth 4 aHopfieldNetwork))
 7         (*HopfieldWeights* (nth 5 aHopfieldNetwork)))
 8 
 9     (defun deltaEnergy (row-index y &aux (temp 0.0))  ;; lexically scoped
10       (dotimes (j *num-inputs*)
11         (setq temp (+ temp (* (aref *HopfieldWeights* row-index j) (aref y j)))))
12       (- (* 2.0 temp) (aref *tempStorage* row-index)))
13 
14     (dotimes (ii numberOfIterations) ;; main code
15       (dotimes (i *num-inputs*)
16         (setf (aref *inputCells* i)
17               (if (> (deltaEnergy i *inputCells*) 0)
18                   1
19                   0))))))

Function test in the next listing uses three different patterns for each test. Note that only the last pattern gets plotted to the output graphics PNG file for the purpose of producing figures for this chapter. If you want to produce plots of other patterns, edit just the third pattern defined on line AAAAA. The following plotting functions are inner lexically scoped so they have access to the data defined in the enclosing let expression in lines 16-21:

  • plotExemplar - plots a vector of data
  • plot-original-inputCells - plots the original input cells from training data
  • plot-inputCells - plots the modified input cells (a few cells randomly flipped in value)
  • modifyInput - scrambles training inputs
 1 (defun test (&aux aHopfieldNetwork)
 2   (let ((tdata '(  ;; sample sine wave data with different periods:
 3                  (1 0 0 0 1 0 0 0 1 0 0 0 1 0 0 0 1 0 0 0 0 0 1 1 0 0 0)
 4                  (0 1 1 0 0 0 0 0 1 0 0 1 0 0 0 0 0 1 0 0 0 1 1 0 0 1 0)
 5                  (0 0 0 1 1 0 0 0 0 0 0 1 1 0 0 0 0 0 1 1 0 0 1 1 0 1 1)))
 6         (width 300)
 7         (height 180))
 8     (vecto::with-canvas (:width width :height height)
 9       (plotlib:plot-string-bold 10 (- height 14) "Hopfield pattern classifier")
10 
11       ;; Set up network:
12       (print tdata)
13       (setq aHopfieldNetwork (Hopfield-Init tdata))
14 
15       ;; lexically scoped variables are accesible by inner functions:
16       (let ((*num-inputs* (nth 0 aHopfieldNetwork))
17             (*num-training-examples*  (nth 1 aHopfieldNetwork))
18             (*training-list* (nth 2 aHopfieldNetwork))
19             (*inputCells* (nth 3 aHopfieldNetwork))
20             (*tempStorage* (nth 4 aHopfieldNetwork))
21             (*HopfieldWeights* (nth 5 aHopfieldNetwork)))
22 
23         (defun plotExemplar (row &aux (dmin 0.0) (dmax 1.0) (x 20) (y 40))
24           (let ((YSize (array-dimension *training-list* 1)))
25             (plotlib:plot-string (+ x 20) (- height (- y 10))
26                                  "Original Training Exemplar")
27             (dotimes (j Ysize)
28               (plotlib:plot-fill-rect
29                (+ x (* j plot-size+1)) (- height y) plot-size plot-size
30                (truncate (*
31                            (/  (- (aref *training-list* row j) dmin)
32                                (- dmax dmin))
33                            5)))
34               (plotlib:plot-frame-rect (+ x (* j plot-size+1))
35                                        (- height y) plot-size plot-size))))
36 
37         (defun plot-original-inputCells (&aux (dmin 0.0) (dmax 1.0) (x 20) (y 80\
38 ))
39           (let ((Xsize (array-dimension *inputCells* 0)))
40             (plotlib:plot-string (+ x 20) (- height (- y 10)) "Scrambled Inputs")
41             (dotimes (j Xsize)
42               (plotlib:plot-fill-rect
43                (+ x (* j plot-size+1)) (- height y) plot-size plot-size
44                (truncate (*
45                            (/  (- (aref *inputCells* j) dmin) (- dmax dmin))
46                            5)))
47               (plotlib:plot-frame-rect (+ x (* j plot-size+1))
48                                        (- height y) plot-size plot-size))))
49 
50         (defun plot-inputCells (&aux (dmin 0.0) (dmax 1.0) (x 20) (y 120))
51           (let ((Xsize (array-dimension *inputCells* 0)))
52             (plotlib:plot-string (+ x 20) (- height (- y 10))
53                                  "Reconstructed Inputs")
54             (dotimes (j Xsize)
55               (plotlib:plot-fill-rect
56                (+ x (* j plot-size+1)) (- height y) plot-size plot-size
57                (truncate (* (/
58                              (- (aref *inputCells* j) dmin)
59                              (- dmax dmin))
60                             5)))
61               (plotlib:plot-frame-rect
62                  (+ x (* j plot-size+1)) (- height y) plot-size plot-size))))
63 
64         (defun modifyInput (arrSize arr)  ;; modify input array for testing
65           (dotimes (i arrSize)
66             (if (< (random 50) 5)
67                 (if (> (aref arr i) 0)
68                     (setf (aref arr i) -1)
69                     (setf (aref arr i) 1)))))
70 
71         ;; Test network on training data that is randomly modified:
72 
73         (dotimes (iter 10) ;; cycle 10 times and make 10 plots
74           (dotimes (s *num-training-examples*)
75             (dotimes (i *num-inputs*)
76               (setf (aref *inputCells* i) (aref *training-list* s i)))
77             (plotExemplar s)
78             (modifyInput *num-inputs* *inputCells*)
79             (plot-original-inputCells)
80             (dotimes (call-net 5) ;; iterate Hopfield net 5 times
81               (HopfieldNetRecall aHopfieldNetwork 1)  ;; calling with 1 iteration
82               (plot-inputCells)))
83 
84           (vecto::save-png
85            (concatenate
86             'string
87             "output_plot_hopfield_nn_" (format nil "~5,'0d" iter) ".png")))))))

The plotting functions in lines 23-62 use the plotlib library to make the plots you saw earlier. The function modifyInput in lines 64-69 randomly flips the values of the input cells, taking an original pattern and slightly modifying it.

Hopfield neural networks, at least to some extent, seem to model some aspects of human brains in the sense that they can function as content-addressable (also called associative) memories. Ideally a partial input pattern from a remembered input can reconstruct the complete original pattern. Another interesting feature of Hopfield networks is that these memories really are stored in a distributed fashion: some of the weights can be randomly altered and patterns are still remembered, but with more recall errors.

In the next chapter we will look at deep learning neural networks as well as get a practical example of mixing Common Lisp and Java code, required since the deep learning library we will use in written in Java.

Using Armed Bear Common Lisp With DeepLearning4j

This chapter both serves as a recipe for calling the Java deep learning library and also as a general example of “wrapping” other complex Java libraries that you may want to call from Common Lisp code that you write.

DeepLearning4j is a state of the art deep learning library that can handle small to medium data sets on your laptop and very large data sets using a cluster of servers controlled with Apache Spark. Here we just use DeepLearning4j with a small data set and the following examples will run on your laptop if you hav Java 8 installed. Armed Bear Common Lisp (ABCL) is implemented in Java and a compiled version is included in the example directory src/deep_learning_with_abcl so the following examples are self contained except for the Java 8 requirement.

Tutorial on passing data between Common Lisp and Java

The following listing shows the Java code in the source file Simple.java in the directory src/deep_learning_with_abcl. he first two functions modifyString and addTwoNumbers return specific types, in this case a string and an integer. The thrid function modifyArray takes advantage of ABCL’s flexible foreign function interface to Java. We can pass different supported Lisp types to this function and they will be converted automatically to Java types and in returning to Lisp are either converted to simple Lisp types or wrapped as ABCL specific types. We will see more examples of converting data types later.

 1 import org.armedbear.lisp.*;
 2 
 3 public class Simple {
 4   
 5   static public String modifyString(String s) {
 6       return s + "123";
 7   }
 8   static public int addTwoNumbers(int a, int b) {
 9       return a + b;
10   }
11   static public Object modifyArray(Object values) {
12       return values;
13   }
14 }

The following listing of file simple.lisp shows how to call the three Java metods defined in the last listing. In lines 8, 17, and 26 we see the use of jmethod to wrap a Java class method as a function usable in ABCL. The value in variable class (defined in lines 6, 15, and 24) references the name of the class in the Java code, in this case the class was Simple. To call into Java code we use jcall (lines 9, 18, and 27). The first two calls to jcall are simple because we are passing native Java types (int and java.lang.String). The third example on line 27 is more complicated because we need to convert a Common Lisp list to a Java array.

 1 (add-to-classpath '("Simple.jar"))
 2 
 3 (defun add2 (i1 i2)
 4   (print (jclass "Simple"))
 5   (let* ((param nil) ;; ? not sure about this
 6          (class (jclass "Simple"))
 7          (intclass (jclass "int"))
 8          (method (jmethod class "addTwoNumbers" intclass intclass))
 9          (result (jcall method param i1 i2)))
10     (format t "in add2, result of calling addTwoNumbers(2, 4): ~a~%" result)
11     result))
12 
13 (defun modify-string (s)
14   (let* ((param nil) ;; ? not sure about this
15          (class (jclass "Simple"))
16          (string-class (jclass "java.lang.String"))
17          (method (jmethod class "modifyString" string-class))
18          (result (jcall method param s)))
19     (format t "in add2, result of calling modify-string(...)): ~a~%" result)
20     result))
21 
22 (defun modify-list (ls)
23   (let* ((param nil) ;; ? not sure about this
24          (class (jclass "Simple"))
25          (string-class (jclass "java.lang.Object"))
26          (method (jmethod class "modifyArray" string-class))
27          (result (jcall method param (jarray-from-list ls))))
28     (format t "in mls, result of calling modifyArray(...): ~a~%" result)
29     result))

Instead of running the following commands manually, you can use the Makefile and run “make simple” to compile Simple.java and start a ABCL repl. I show the commands individually here for reference:

 1 javac Simple.java -cp abcl.jar
 2 jar cvf simple.jar Simple.class
 3 java -jar abcl.jar -cp abcl.jar;simple.jar;. Simple
 4 Armed Bear Common Lisp 1.4.0
 5 CL-USER(1): (load "simple.lisp")
 6 T
 7 CL-USER(2): (add2 1 15)
 8 
 9 #<java.lang.Class class Simple {24248033}> in add2, result of calling addTwoNumb\
10 ers(2, 4): 16
11 16
12 CL-USER(3): (modify-string "dog")
13 in add2, result of calling modify-string(...)): dog123
14 "dog123"
15 [1] CL-USER(4): (modify-list '(1 2 3))
16 in mls, result of calling modifyArray(...): #(1 2 3)
17 #(1 2 3)
18 [1] CL-USER(5): (modify-list '("cat" "dog"))
19 in mls, result of calling modifyArray(...): #(cat dog)
20 #("cat" "dog")
21 [1] CL-USER(6): 

Note that Java arrays must have elements of the same type so we could not make a call like:

(modify-list '(1 2 3.14 "cat" "dog"))

because an error would be thrown that would look like:

#<THREAD "interpreter" {10F00ACA}>: Debugger invoked on condition of type JAVA-E\
XCEPTION
  Java exception 'java.lang.IllegalArgumentException: array element type mismatc\
h'.

Using DeepLearning4j Java Code

This example uses both the DeepLearning4j library and also a slightly modified version of an example program in my book Power Java. You can read the book for free online and you might want to read the chapter “Deep Learning Using Deeplearning4j” for background. All required Java code is included in the repository for this book but to run this example you will need to have both Java 8 and maven installed.

The sample data we will use is the University of Wisconsin cancer data.

Building an uber-jar file with all dependencies

We need a JAR file that contains both the required DeepLearning4j code and also the Java wrapper code that provides an easier interface to call using the Java foreign function interface in ABCL.

In the git repository top level directory, change directory to:

cd deep_learning_with_abcl/java_code_for_jar_library/

You need Java 8 and maven installed to build an uber jar (that is a jar with the Java code and all required jar files, including DeepLearning4j dependencies used in the Java code for this project):

mvn package
cp target/uber-lisp-deep-learning.jar ..
mvn clean
cd ..

You should now have a new jar file uber-lisp-deep-learning.jar in the deep_learning_with_abcl directory. If you are curious about the contents of this JAR file then try this:

jar tvf uber-lisp-deep-learning.jar

You are seeing compiled code for the wrapper from my Power Java book (modified slighty here to make it easier to call from Lisp), DeepLearning4j, and all other required dependencies. If you want to wrap other Java libraries for use with ABCL then hopefully the code and maven pom.xml configuration file in the subdirectory java_code_for_jar_library will serve as a useful example.

Running the Example Lisp Client Code

There is a Makefile that builds the local Java client code and starts up ABCL Lisp (following listing has been edited to avoid line wraps so als look at the file Makefile):

dl: compile_java_dl run_dl

compile_java_dl:
	javac LispInterfaceDataFetcher.java -cp abcl.jar:uber-lisp-deep-learning.jar:.
	javac LispInterfaceDataSetIterator.java -cp \
    abcl.jar:uber-lisp-deep-learning.jar:.
	javac DeepBeliefNetworkLispInterfaceData.java -cp \
    abcl.jar:uber-lisp-deep-learning.jar:.
	javac LispInterface.java -cp abcl.jar:uber-lisp-deep-learning.jar:.
	jar cvf dl.jar DeepBeliefNetworkLispInterfaceData.class \
    LispInterface.class LispInterfaceDataFetcher.class \
    LispInterfaceDataSetIterator.class

run_dl:
	java -jar abcl.jar -cp \
    abcl.jar:abcl-contrib-1.4.0.jar:dl.jar:uber-lisp-deep-learning.jar:. \
    LispInterface

simple: compile_java_simple run_simple

compile_java_simple:
	javac Simple.java -cp abcl.jar
	jar cvf simple.jar Simple.class
	#rm -f Simple.class

run_simple:
	java -jar abcl.jar -cp abcl.jar:simple.jar;. Simple

The following listing of file deep-learning.lisp shows the Common Lisp wrapper code for this example. The function train (lines 4-18) has arguments defining the size of the neural network (number of neurons in the input layer, in all the hidden layers, and the number of neurons in the output layer. These values should be compatible with the input training comma separated values (CSV) file (i.e., the value for numInput should be the number of columns in the CSV file minus one and the value of labelColumnIndex should be the column index for the output label.)

ABCL has a contributed library JSS and I copied the utility function jarray-to-list to convert Java arrays to Common Lisp lists. The function evaluateData (lines 27-34) can be used to try the trained model on new data sets. Using files to pass data is convenient for development and testing and is okay for deployed systems since the overhead of writing and reading files is negligible compared to computation costs of training and using deep learning models.

 1 (add-to-classpath '("uber-lisp-deep-learning.jar"))
 2 (add-to-classpath '("dl.jar"))
 3 
 4 (defun train (numInput numHidden numberOfLayers
 5               labelColumnIndex numSamples
 6               iterations trainingCsvFilePath)
 7   (let* ((param nil) ;; ? not sure about this
 8          (class (jclass "LispInterface"))
 9          (int-class (jclass "int"))
10          (string-class (jclass "java.lang.String"))
11          (method (jmethod class "trainNetwork" int-class int-class
12                           int-class int-class int-class
13                           int-class string-class))
14          (result (jcall method param numInput numHidden numberOfLayers
15                         labelColumnIndex numSamples
16                         iterations trainingCsvFilePath)))
17     (format t "in mls, result of calling trainNetwork(...): ~a~%" result)
18     result))
19 
20 ;; copied from JSS contrib: jarray-to-list:
21 (defun jarray-to-list (jarray)
22   "Convert the Java array named by JARRARY into a Lisp list."
23   (declare (optimize (speed 3) (safety 0)))
24   (loop :for i :from 0 :below (jarray-length jarray)
25         :collecting (jarray-ref jarray i)))
26 
27 (defun evaluateData (dataCsvFilePath)
28   (let* ((param nil) ;; ? not sure about this
29          (class (jclass "LispInterface"))
30          (string-class (jclass "java.lang.String"))
31          (method (jmethod class "evaluateData" string-class))
32          (result (jcall method param dataCsvFilePath)))
33     (format t "in mls, result of calling trainNetwork(...): ~a~%" result)
34     (jarray-to-list result)))
35 
36 ;; (train 9 3 3 9 48 100 "data/training.csv")
37 
38 ;; (evaluateData "data/try_it_out.csv")

You can run the code with the sample data using (a lot of printout is not shown here):

$ make
Armed Bear Common Lisp 1.4.0
Java 1.8.0_111 Oracle Corporation
Java HotSpot(TM) 64-Bit Server VM
Low-level initialization completed in 0.41 seconds.
Startup completed in 1.896 seconds.
Type ":help" for a list of available commands.
CL-USER(1): (load "deep-learning.lisp")
T
CL-USER(2):  (train 9 3 3 9 600 100 "data/training.csv")
==========================Scores========================================
 Accuracy:  0.7667
 Precision: 0.7667
 Recall:    1
 F1 Score:  0.8679245283018869
===========================================================================
in mls, result of calling trainNetwork(...): done training
"done training"
"done training"
CL-USER(3): (evaluateData "data/try_it_out.csv")
(0 1 0 0 0 0 1 0 0 0 0 0 0 1 1 1 0 0 1 0 0 0 1 0 0 0 0 0 1 0 0 0 1 0 0 1 0 0 0 0\
 1 0 1 0 1 0 1 0)

In the last output, zero values indicate non-malignant while one values indicate a prediction of malignant for each test data sample.

The DeepLearning4J library implements several types of networks and here we just looked at a simple example that also serves as an example for calling Jaca libraries. While it is often more practical to use languages like Java or Python for deep learning because of available libraries written in these languages, I think a case can be made for hybrid Common Lisp and Java systems, taking advantage of Common Lisp for general programming, knowledge management, symbolic processing, etc., while using neural models for recognizing images, classifying text, linguistic processing, and other use cases that deep learning excels in.

Book Wrapup

Congratulations for finishing this book!

I love programming in Lisp languages with concise code and a bottom-up approach to development. I hope you now also share this enthusiasm with me.

Common Lisp is sometimes criticised as not having as many useful libraries as some newer languages like Python and Java, and this is a valid criticism. That said, I hope the wide variety of examples in this book will convince you that Common Lisp is a good choice for many types of programming projects.

I would like to thank you for reading my book and I hope that you enjoyed it. As I mentioned in the Introduction I have been using Common Lisp since the mid-1980s, and other Lisp dialects for longer than that. I have always found something almost magical developing in Lisp. Being able to extend the language with macros and using the development technique of building a mini-language in Lisp customized for an application enables programmers to be very efficient in their work. I have usually found that this bottom-up development style helps me deal with software complexity because the lower level functions tend to get well tested while the overall system being developed is not yet too complex to fully understand. Later in the development process these lower level functions and utilities almost become part of the programming language and the higher level application logic is easier to understand because you have fewer lines of code to fit inside your head during development.

I think that unless a programmer works in very constrained application domains, it often makes sense to be a polyglot programmer. I have tried, especially in the new material for this fourth edition, to give you confidence that Common Lisp is good for both general software development language and also as “glue” to tie different systems together.

Thank you for buying and reading my book!

Mark Watson