find-instancesInstance Retrievalmake-instances-of-class-vectorfind-instances-of-classGoTo Top

find-instances-of-class   unit-classes-specifier => unit-instances[Function]

Purpose
Return a list of all unit instances of the specified unit classes.

Package   :gbbopen

Module   :gbbopen-core

Arguments and values

unit-classes-specifier     An extended unit-classes specification (see below)
unit-instances     A proper list of unit instances

Returns
A newly consed list of all unit instances of the unit classes specified by unit-class-specifier, whether or not they reside on any space instance.

Detailed syntax

unit-classes-specifier ::= t | single-unit-class-specifier | (single-unit-class-specifier+)

single-unit-class-specifier ::= atomic-unit-class | (atomic-unit-class subclassing-specifier)
atomic-unit-class ::= unit-class | unit-class-name
subclassing-specifier ::= :plus-subclasses | :no-subclasses | + | =

The shorthand + subclasses specifier is equivalent to :plus-subclasses and = to :no-subclasses.

See also
    class-instances-count
    do-instances-of-class
    make-instances-of-class-vector
    map-instances-of-class
    map-instances-on-space-instances
    map-sorted-instances-of-class

Example
Return the list of all hyp unit instances:

  > (find-instances-of-class 'hyp)
  (#<hyp 233 (1835 4791) 0.89 [5..35]>
   #<hyp 319 (1835 8419) 0.91 [4..12]>
   #<hyp 419 (1835 4791) 0.85 [5..35]>
   #<hyp 231 (1488 7405) 0.63 [0..8]>
   #<hyp 311 (896 388) 0.68 [0..6]> 
     ...
   #<hyp 331 (1835 8419) 0.88 [15..30]>
   #<hyp 183 (1835 4791) 0.82 [0..35]>
   #<hyp 335 (1835 8419) 0.92 [15..35]>)
  >

Note
In general, do-instances-of-class or map-instances-of-class is preferred over operating on the list created by find-instances-of-class.


The GBBopen Project


find-instancesInstance Retrievalmake-instances-of-class-vectorfind-instances-of-classGoTo Top