jpl

Class Tuple

java.lang.Object

jpl.Term

jpl.Compound

jpl.Tuple

Direct Known Subclasses:

Tuple.Pair

public class Tuple
extends Compound

A Tuple is a Compound, used to represent Prolog tuples, the closest thing Prolog has to a data structure.

 Tuple triple = 
     new Tuple(
         jpl.Util.toTermArray(
             new Atom( "a" ),
             new Atom( "b" ),
             new Atom( "c" ) ) );
 

This constructor (using the jpl.Util class for convenience) creates a triple corresponding to the Prolog tuple (a,b,c).

The Tuple.Pair class can be used to create 2-element tuples. Use the let() method to obtain a reference to the ith (starting from 0) element in the Tuple.

Copyright (C) 1998 Fred Dushin

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library Public License for more details.

Version:

$Revision: 1.1.1.1 $

Author:

Fred Dushin

See Also:

Compound

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tuple.Pair A Pair is a two-element Tuple

Field Summary

Fields inherited from class jpl.Compound

args_, atom_

Constructor Summary

Constructors

Constructor and Description
Tuple(Term[] elts) Create a Tuple whose arity is determined by the size of the input array.
Tuple(Term t0, Term t1) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4, Term t5) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4, Term t5, Term t6) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4, Term t5, Term t6, Term t7) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4, Term t5, Term t6, Term t7, Term t8) This constructor is shorthand for
Tuple(Term t0, Term t1, Term t2, Term t3, Term t4, Term t5, Term t6, Term t7, Term t8, Term t9) This constructor is shorthand for

Method Summary

Modifier and Type	Method and Description
String	debugString()
Term	elt(int i)
String	toString() Converts a Compound to its String form, atom( arg_1, ..., arg_n )

Methods inherited from class jpl.Compound

args, atom, computeSubstitution, equals, from_term_t, ith, put

Methods inherited from class jpl.Term

computeSubstitutions, debugString, from_term_t, terms_equals, terms_to_term_ts, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Tuple

public Tuple(Term[] elts)

Create a Tuple whose arity is determined by the size of the input array.

Parameters:

elts - the Terms in the Tuple

Tuple

public Tuple(Term t0,
             Term t1)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4,
             Term t5)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4, 
                       t5 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

t5 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4,
             Term t5,
             Term t6)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4, 
                       t5, t6 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

t5 - a jpl.Term

t6 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4,
             Term t5,
             Term t6,
             Term t7)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4, 
                       t5, t6, t7 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

t5 - a jpl.Term

t6 - a jpl.Term

t7 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4,
             Term t5,
             Term t6,
             Term t7,
             Term t8)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4, 
                       t5, t6, t7, t8 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

t5 - a jpl.Term

t6 - a jpl.Term

t7 - a jpl.Term

t8 - a jpl.Term

Tuple

public Tuple(Term t0,
             Term t1,
             Term t2,
             Term t3,
             Term t4,
             Term t5,
             Term t6,
             Term t7,
             Term t8,
             Term t9)

This constructor is shorthand for

 new Tuple( 
     Util.toTermArray( t0, t1, t2, t3, t4, 
                       t5, t6, t7, t8, t9 ) )
 

Parameters:

t0 - a jpl.Term

t1 - a jpl.Term

t2 - a jpl.Term

t3 - a jpl.Term

t4 - a jpl.Term

t5 - a jpl.Term

t6 - a jpl.Term

t7 - a jpl.Term

t8 - a jpl.Term

t9 - a jpl.Term

Method Detail

elt

public final Term elt(int i)

Returns:

the ith element in the tuple (starting from 0); null if the index is out of bounds

toString

public String toString()

Description copied from class: Compound

Converts a Compound to its String form, atom( arg_1, ..., arg_n )

Overrides:

toString in class Compound

Returns:

the String representation of a Tuple, in this case, of the form (t0,...,tn-1).

debugString

public String debugString()

Overrides:

debugString in class Compound