The listoflist Reference Manual

Table of Contents

The listoflist Reference Manual

This is the listoflist Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:12:10 2018 GMT+0.

1 Introduction

* Overview 

  The LISTOFLIST package (depends on xarray) contains functions and
  methods for handling list-of-lists as array substitutes as well as
  conversions between the two data structures.  The general API is
  that of XARRAY, but we have added a few convenience functions, as
  well. 

  This is part of the core suite of Common Lisp Statistics System
  (CLS) packages.

* Tasks to do

Originally the following was in the TODO.lisp file.

#+name: Header
#+begin_src lisp :tangle "TODO.lisp"
;;; -*- mode: lisp -*-
;;; Time-stamp: <2012-10-06 09:16:41 tony>
;;; Creation:   <2009-12-10 08:10:39 tony>
;;; File:       TODO.lisp
;;; Author:     AJ Rossini 
;;; Copyright:  (c)2009--, AJ Rossini.  See file LICENSE.mit in
;;;             top-level directory for information.
;;; Purpose:    development support and short-term memory. 

;;; What is this talk of 'release'? Klingons do not make software
;;; 'releases'.  Our software 'escapes', leaving a bloody trail of
;;; designers and quality assurance people in its wake.

;;; This organization and structure is new to the 21st Century
;;; version..   Think, "21st Century Schizoid Man".

#+end_src

* Initialization

#+NAME LoadingLOL
#+BEGIN_SRC lisp :tangle "TODO.lisp"
  (in-package :cl-user)
  (asdf:oos 'asdf:compile-op :listoflist :force t)
;;  (asdf:oos 'asdf:load-op :listoflist)
;;  (ql:quicklisp :listoflist)
#+END_SRC

* Snips to repair and solve

** Unit tests

#+NAME UnitTestExec
#+BEGIN_SRC lisp :tangle "TODO.lisp"
(in-package :listoflist-unittests)
;; (describe (run-tests :suite 'lol-ut))   ;; only from commandline
(run-tests :suite 'lol-ut)
#+END_SRC

#+RESULTS:
: #



** Example Use

#+NAME Examples
#+BEGIN_SRC lisp :tangle "TODO.lisp"
(in-package :lol-user)

(listoflistp '((0d0  1d0  2d0  3d0)
	       (10d0 11d0 12d0 13d0)))
(listoflistp (list (list 0d0  1d0  2d0  3d0)
		   (list 10d0 11d0 12d0 13d0)))
#+END_SRC

* Discussion

2 Systems

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

2.1 listoflist

Author

AJ Rossini

License

MIT

Description

makes listoflist an xarray’able data structure.

Dependencies

• xarray
• clunit

Source

listoflist.asd (file)

Components

• src (module)
• unittest (module)

3 Modules

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

3.1 listoflist/src

Parent

listoflist (system)

Location

src/

Components

• package.lisp (file)
• listoflist.lisp (file)

3.2 listoflist/unittest

Dependency

src (module)

Parent

listoflist (system)

Location

src/

Component

unittests.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 listoflist.asd

Location

listoflist.asd

Systems

listoflist (system)

Packages

listoflist-asd

4.1.2 listoflist/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

• listoflist-unittests
• listoflist-user
• listoflist

4.1.3 listoflist/src/listoflist.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/listoflist.lisp

Exported Definitions

• equal-listoflist (function)
• listoflist->array (function)
• listoflistp (function)
• sublists-of-same-size-p (function)
• transpose-listoflist (function)

Internal Definitions

• array->listoflist (function)
• carray*-lol (function)
• carray-lol (function)
• cvector*-lol (function)
• fill-array-with-list (function)
• listoflists-dimensions (function)
• listsoflists-consistent-dimensions-p (function)
• numeric-type-classifier (function)

4.1.4 listoflist/unittest/unittests.lisp

Parent

unittest (module)

Location

src/unittests.lisp

5 Packages

Packages are listed by definition order.

5.1 listoflist-asd

Source

listoflist.asd

Use List

• asdf/interface
• common-lisp

5.2 listoflist-unittests

unit-testing structure for LISTOFLIST using LIFT.

Source

package.lisp (file)

Nicknames

• listoflist-test
• lol-unittests

Use List

• clunit
• listoflist
• xarray
• common-lisp

5.3 listoflist-user

verification, sandbox, and illustration package for LISTOFLIST.

Source

package.lisp (file)

Nickname

lol-user

Use List

• listoflist
• xarray
• common-lisp

5.4 listoflist

XARRAY support for list-of-list data structures.

Source

package.lisp (file)

Nickname

lol

Use List

• xarray
• common-lisp

Used By List

• listoflist-unittests
• listoflist-user

Exported Definitions

• equal-listoflist (function)
• listoflist->array (function)
• listoflistp (function)
• sublists-of-same-size-p (function)
• transpose-listoflist (function)

Internal Definitions

• array->listoflist (function)
• carray*-lol (function)
• carray-lol (function)
• cvector*-lol (function)
• fill-array-with-list (function)
• listoflists-dimensions (function)
• listsoflists-consistent-dimensions-p (function)
• numeric-type-classifier (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: equal-listoflist X Y

FIXME: This function, when written, should walk through 2 listoflists and return T/nil based on equality.

Package

listoflist

Source

listoflist.lisp (file)

Function: listoflist->array LOL &key TYPE

From a listoflists structure, make an array.

FIXME: need to verify that the listoflists is a valid structure (same size rows, typing if required, etc.

<example>
(defparameter *mdfl-test*
(list (list ’a 1 2.1)
(list ’b 2 1.1)
(list ’c 1 2.0)
(list ’d 2 3.0)))
(length *mdfl-test*)
(length (elt *mdfl-test* 0))

(defparameter *mdfl-test-dt* (make-datatable-from-listoflists *mdfl-test*)) (array-dimensions *mdfl-test-dt*)
</example>

Package

listoflist

Source

listoflist.lisp (file)

Function: listoflistp LISTS

Test for conformance of structure: list whose sublists are of the same size (if ragged is T, then just test that list has elements of type list).

FIXME: should have a flag to verify equivalence of types in case needed to map to a RHO:DATA-FRAME.

Package

listoflist

Source

listoflist.lisp (file)

Function: sublists-of-same-size-p LISTS

Take a list of list, and verify that the sublists are all of the same size. returns size-of-sublist if all sublists same size, otherwise nil

Package

listoflist

Source

listoflist.lisp (file)

Function: transpose-listoflist LISTOFLIST

This function does the moral-equivalent of a matrix transpose on a rectangular list-of-lists data structure.

Assumes listoflist is rectangular, need to see what happens if ragged (or at least check). Could use the listoflistp predicate to confirm.

Package

listoflist

Source

listoflist.lisp (file)

6.2 Internal definitions

6.2.1 Functions

Function: array->listoflist ARR &key TYPE

FIXME: need to write this.

Package

listoflist

Source

listoflist.lisp (file)

Function: carray*-lol DIMENSIONS &rest ELEMENTS

Return a (simple-array element-type dimensions) containing elements, coerced to element-type, where the elemen-type is obtained using numeric-type-classifier.

Package

listoflist

Source

listoflist.lisp (file)

Function: carray-lol ELEMENT-TYPE DIMENSIONS &rest ELEMENTS

Return a (simple-array element-type dimensions) containing elements, coerced to element-type.

Package

listoflist

Source

listoflist.lisp (file)

Function: cvector*-lol &rest ELEMENTS

Return a (simple-array element-type (*)) containing elements, coerced to element-type, where the elemen-type is obtained using numeric-type-classifier.

Package

listoflist

Source

listoflist.lisp (file)

Function: fill-array-with-list ARRAY LIST

Fills array with elements from list, coerced to the appropriate type. No error checking, meant to be used internally. Return array.

Package

listoflist

Source

listoflist.lisp (file)

Function: listoflists-dimensions LOL

We assume row-major, that is each sublist denotes a row, and columns are formed by taking the jth element from each list to form the jth column

Package

listoflist

Source

listoflist.lisp (file)

Function: listsoflists-consistent-dimensions-p &rest LIST-OF-LIST-NAMES

Check if the lengths of the lists are equal (T, otherwise NIL), to justify further processing and initial conditions.

Package

listoflist

Source

listoflist.lisp (file)

Function: numeric-type-classifier LIST

Numeric type classifier, finds the smallest subtype that can accomodate the elements of list, in the ordering fixnum < integer < float < complex < t. Rational, float (any kind) are classified as double-float, and complex numbers as (complex double-float). Meant to be used by simple array-constructing functions. Upgraded-array-element-type is called on end result.

Package

listoflist

Source

listoflist.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types