sstart fitting the docs
This commit is contained in:
parent
380132095a
commit
ad710f3a0c
27
CXX/yapa.hh
27
CXX/yapa.hh
@ -1,9 +1,24 @@
|
||||
/// @{
|
||||
|
||||
#ifndef YAPA_HH
|
||||
#define YAPA_HH 1
|
||||
|
||||
/**
|
||||
Prolog operates over constants, called atoms
|
||||
YAP, like lisp, associates properties with atoms.
|
||||
*
|
||||
* @defgroup yap-cplus-interface An object oriented interface for YAP.
|
||||
*
|
||||
* @ingroup ChYInterface
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
* Prolog operates over constants, called atoms. YAP's stores most data as a list
|
||||
* of properties for atoms. Properties include functors, data-base tecords, predicates. operators,
|
||||
* and more.
|
||||
*
|
||||
*
|
||||
*/
|
||||
/**
|
||||
Tne different tgaas area represented through PropTag.
|
||||
*/
|
||||
enum PropTag {
|
||||
/// predicate
|
||||
@ -19,7 +34,7 @@ enum PropTag {
|
||||
TRANSLATION_TAG = TranslationProperty, // 0xFFF4,
|
||||
/// ensure the atom may not be garbafe colected
|
||||
HOLD_TAG = HoldProperty, // 0xFFF6
|
||||
/// named mutEX
|
||||
/// named mutEX
|
||||
MUTEX_TAG = MutexProperty, // 0xFFF6,
|
||||
/// A typed array, may be in-db or in-stack deped
|
||||
ARRAY_TAG = ArrayProperty, // 0xFFF7,
|
||||
@ -35,7 +50,7 @@ enum PropTag {
|
||||
BLOB_TAG = BlobProperty, // 0xFFFE,
|
||||
/// Prolog operator,
|
||||
OPERATOR_TAG = OpProperty, // 0xFFFF,
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Atom
|
||||
@ -90,10 +105,12 @@ class YAPProp {
|
||||
public:
|
||||
/// get name of property
|
||||
// virtual YAPAtom name();
|
||||
virtual ~YAPProp() {};
|
||||
virtual ~YAPProp() {};
|
||||
|
||||
};
|
||||
|
||||
|
||||
#endif /* YAPA_HH */
|
||||
|
||||
/// @}
|
||||
|
||||
|
@ -14,8 +14,8 @@
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
* Data-base component of C++ interface to YAP. It manipulates sets of
|
||||
* atoms, each one containing a number of props.
|
||||
* These classes define the main data-structures stored in the Data-base component: atoms, functors
|
||||
* and predicates.
|
||||
*/
|
||||
|
||||
class YAPTerm;
|
||||
@ -136,7 +136,7 @@ protected:
|
||||
CACHE_REGS
|
||||
BACKUP_MACHINE_REGS();
|
||||
Term *modp = NULL;
|
||||
names = MkVarTerm ();
|
||||
names = MkVarTerm ();
|
||||
const unsigned char *us = (const unsigned char *)s0;
|
||||
out =
|
||||
Yap_BufferToTermWithPrioBindings(us, strlen(s0), TermNil, 1200, names);
|
||||
@ -329,3 +329,5 @@ public:
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/// @}
|
||||
|
@ -13,7 +13,7 @@
|
||||
*
|
||||
* @defgroup yap-cplus-interface An object oriented interface for YAP.
|
||||
*
|
||||
* @ingroup ChYInterface
|
||||
* @ingroup yap-cplus-interface
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
|
16
CXX/yapie.hh
16
CXX/yapie.hh
@ -1,3 +1,17 @@
|
||||
/**
|
||||
* @{
|
||||
*
|
||||
* @defgroup yap-cplus-error-hanadlinge Errir Handling in the YAP interface.
|
||||
*
|
||||
* @ingroup yap-cplus-interface
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
* These classes define an object that we can then throw when an error
|
||||
* or unexoected event interrupts YAP. Often, the object is built by
|
||||
* YAP itself, but we may generate our own errors.
|
||||
*/
|
||||
|
||||
|
||||
#ifndef YAPIE_HH
|
||||
#define YAPIE_HH
|
||||
@ -36,3 +50,5 @@ public:
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
/// @}
|
||||
|
17
CXX/yapq.hh
17
CXX/yapq.hh
@ -1,3 +1,16 @@
|
||||
/**
|
||||
* @{
|
||||
^
|
||||
* @defgroup yap-cplus-query-hanadlinge Query Handling in the YAP interface.
|
||||
*
|
||||
* @ingroup yap-cplus-interface
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
* These classes define the concepts of engine ana of query.Ann engine is an environment where we can rum
|
||||
* Prolog, that is, where we can run queries.
|
||||
*/
|
||||
|
||||
#ifndef YAPQ_HH
|
||||
#define YAPQ_HH 1
|
||||
|
||||
@ -217,3 +230,7 @@ public:
|
||||
};
|
||||
|
||||
#endif /* YAPQ_HH */
|
||||
|
||||
/// @}
|
||||
|
||||
|
||||
|
16
CXX/yapt.hh
16
CXX/yapt.hh
@ -1,3 +1,17 @@
|
||||
/**
|
||||
* @{
|
||||
* @defgroup yap-cplus-term-handling Term Handling in the YAP interface.
|
||||
*
|
||||
* @ingroup yap-cplus-interface
|
||||
* @tableofcontents
|
||||
*
|
||||
*
|
||||
* These classes define a term objectthat can be refined, Currently, all exported terms have an
|
||||
* handle, in the SWI-Prolog style.
|
||||
*
|
||||
* Nottce that terms are forcefully destroyed during backtracking.
|
||||
*/
|
||||
|
||||
|
||||
#ifndef YAPT_HH
|
||||
#define YAPT_HH 1
|
||||
@ -445,3 +459,5 @@ public:
|
||||
const char *text() { return (const char *)AtomOfTerm(gt())->StrOfAE; }
|
||||
};
|
||||
#endif /* YAPT_HH */
|
||||
|
||||
/// @}
|
||||
|
Reference in New Issue
Block a user