opencog-link-grammar / link-grammar / dict-atomese / local-as.h

/*
 * local-as.h
 *
 * Local copy of AtomSpace
 *
 * Copyright (c) 2022 Linas Vepstas <linasvepstas@gmail.com>
 */

#include <mutex>
#include <opencog/atomspace/AtomSpace.h>
#include <opencog/persist/api/StorageNode.h>

using namespace opencog;

class Local
{
public:
	std::mutex dict_mutex; // Avoid corruption of Dictionary
	std::mutex pair_mutex; // Guarantee unique link-name assignment

	// General housekeeping
	bool using_external_as; // If false, then `asp` below is private.
	AtomSpacePtr asp;
	StorageNodePtr stnp;   // Might be nullptr
	Handle idanch;         // (Anchor "*-LG-issued-link-id-*")
	uint64_t last_id;      // Numeric value of above
	Handle bany;           // (BondNode "ANY")
	Handle prk;            // (Predicate "*-fetched-pair-*")

	// Section config
	bool enable_sections;  // Enable use of sections
	int extra_pairs;       // Supplement sections with pairs
	bool extra_any;        // Supplement sections with ANY

	// Sections
	Handle miks;           // (Predicate "*-Mutual Info Key cover-section")
	int cost_index;        // Offset into the FloatValue
	double cost_cutoff;    // MI below this is rejected.
	double cost_default;   // This MI is used if key is missing.
	double cost_scale;
	double cost_offset;

	// Word-pair config -- Disjuncts made from pairs
	int pair_disjuncts;    // Max number of pair connectors in a disjunct.
	bool pair_with_any;    // Add ANY pairs to pair disjuncts.

	// Word-pairs
	Dictionary pair_dict;  // Cache of pre-computed word-pair exprs.
	std::unordered_map<std::string, bool> have_pword;  // T/F cache.
	Handle prp;            // (Predicate "word-pair") or (Bond "ANY")
	Handle mikey;          // (Predicate "*-Mutual Info Key-*")
	Handle miformula;      // (DefinedProcedure "*-dynamic MI ANY")
	int pair_index;        // Offset into the FloatValue
	double pair_cutoff;    // MI below this is rejected.
	double pair_default;   // This MI is used if key is missing.
	double pair_scale;
	double pair_offset;

	// Any link type
	bool any_disjuncts;   // Create disjuncts created entirely from ANY
	double any_default;   // Default cost (post-scaling)
	Exp* any_expr;        // Everyone can share this.

	bool enable_unknown_word;
};

Dictionary create_pair_cache_dict(Dictionary);

const char* ss_add(const char *, Dictionary);

double total_usage_time(void);

bool section_boolean_lookup(Dictionary, const char*);
bool pair_boolean_lookup(Dictionary, const char*);

Dict_node * lookup_section(Dictionary, const Handle& germ);

Exp* make_sect_exprs(Dictionary, const Handle& germ);
Exp* make_cart_pairs(Dictionary, const Handle& germ, Pool_desc*,
                     const HandleSeq&, int arity, bool any);
Exp* make_any_exprs(Dictionary, Pool_desc*);

void make_dn(Dictionary, Exp*, const char*);

// These work with both Dictionary and Sentence Exp_pools.
void or_enchain(Pool_desc*, Exp* &orhead, Exp*);
void and_enchain_left(Pool_desc*, Exp* &orhead, Exp* &ortail, Exp*);
void and_enchain_right(Pool_desc*, Exp* &orhead, Exp* &ortail, Exp*);

Handle get_lg_conn(Local*, const Handle& pair);
std::string cached_linkname(Local*, const Handle& pair);
void fetch_link_id(Local*);
void store_link_id(Local*);

//----