COMCSNet Class Reference

OpenMind CommonSense Main API. More...

#include <omcsnet.h>

Collaboration diagram for COMCSNet:

[legend]List of all members.

Public Member Functions
bool	Load (const std::string &a_path)
	Loads an optimized binary predicates file from disk.
bool	Save (const std::string &a_path)
	Saves an optimized binary predicates file to disk.
bool	LoadPredicateFile (const std::string &a_path)
	Loads a raw text predicates file.
std::string	LookupString (const SemanticID a_id)
	Lookup a string in the TextID Map using a semantic ID.
bool	FindAnalogous (CFindAnalogousConfig &a_config)
	Find all concepts that are analogous to a concept.
bool	FindContext (const std::string &a_conceptList, CFindContextConfig &a_config)
	Finds all concepts within the same context as one of more source concepts.
bool	FindPathFromA_To_B (const std::string &a_src, const std::string &a_dst, CFindPathConfig &a_config)
	Finds all semantic paths between two concepts.
CSemanticConcept *	LookupConcept (const std::string &a_name)
	Lookup a specific concept using its textual name.
CSemanticConcept *	LookupConcept (const SemanticID a_id)
	Lookup a specific concept using its numeric ID.
	COMCSNet ()
	Constructor.
	~COMCSNet ()
	Destructor.
Private Member Functions
bool	p_AnalogousProcessLinkMap (CLinkMap *a_linkMap, CFindAnalogousConfig &a_config)
	Process a link map during 'Find Analogous' searching.
bool	p_AnalogousProcessBackwardLinkMap (CLinkMap *a_linkMap, CFindAnalogousConfig &a_config, const RelationType a_relation)
	Process a backwards link map during 'Find Analogous' searching.
void	p_AnalogousProcessLink (CSemanticLink *a_link, CFindAnalogousConfig &a_config)
	Process a semantic link during 'Find Analogous' searching.
void	p_AnalogousProcessBackwardLink (CSemanticLink *a_link, CFindAnalogousConfig &a_config, const RelationType a_relation)
	Process a backwards link during 'Find Analogous' searching.
void	p_AnalogousProcessWeightedNode (CAnalogousWeightNode *a_node)
	Process a weighted candidate node during 'Find Analogous' searching.
bool	p_FindContextProcessLinkMap (CLinkMap *a_linkMap, CFindContextConfig &a_config, const float a_oldScore)
	Process a link map during 'Find Context' searching.
Private Attributes
CTextIDMap	m_textIDMap
	Map of TextualName->ID associations for concepts.
CSemanticIDGenerator	m_idFactory
	Generates unique IDs for concepts and semantic links.
CConceptMap	m_conceptMap
	Map of semantic concepts.
CLinkMap	m_linkMap
	Map of semantic links.

---

Detailed Description

OpenMind CommonSense Main API.

Definition at line 39 of file omcsnet.h.

---

Constructor & Destructor Documentation

COMCSNet::COMCSNet (   )  [inline]

Constructor. Definition at line 139 of file omcsnet.h.

COMCSNet::~COMCSNet (   )  [inline]

Destructor. Definition at line 142 of file omcsnet.h.

---

Member Function Documentation

bool COMCSNet::FindAnalogous (  CFindAnalogousConfig &  a_config  )

Find all concepts that are analogous to a concept. Definition at line 72 of file omcsnet.cpp. References CFindAnalogousConfig::AddNodeToResults(), CFindAnalogousConfig::AllowVisit(), CAnalogousWeightNodeMap_i, DPRINT, CSemanticConcept::GetLinks(), CFindAnalogousConfig::GetNodeName(), CFindAnalogousConfig::GetNumResults(), CFindAnalogousConfig::GetWeightedIterator(), CFindAnalogousConfig::GetWeightedNode(), CAnalogousWeightNode::GetWeightValue(), LookupConcept(), MAX_RELATIONS, p_AnalogousProcessLinkMap(), and p_AnalogousProcessWeightedNode().

Here is the call graph for this function:

bool COMCSNet::FindContext (  const std::string &  a_conceptList, CFindContextConfig &  a_config )

Finds all concepts within the same context as one of more source concepts. Definition at line 232 of file omcsnet.cpp. References CFindContextConfig::AddNodeToResults(), CFindContextConfig::AllowVisit(), CResultsList_i, DPRINT, CSemanticConcept::GetID(), CSemanticConcept::GetLinks(), CFindContextConfig::GetNumResults(), CFindContextConfig::GetScoreIterator(), CFindContextConfig::GetScoreQueue(), CConceptMap::Lookup(), LookupConcept(), m_conceptMap, MAX_RELATIONS, p_FindContextProcessLinkMap(), and CFindContextConfig::QueueScore().

Here is the call graph for this function:

bool COMCSNet::FindPathFromA_To_B (  const std::string &  a_src, const std::string &  a_dst, CFindPathConfig &  a_config )

Finds all semantic paths between two concepts. Definition at line 571 of file omcsnet.cpp. References CFindPathConfig::AllowVisit(), CFindPathConfig::CheckCurrentPath(), CLinkList_ri, DPRINT, CSemanticConcept::FindPathTo(), CSemanticLink::GetDest(), CSemanticConcept::GetID(), CSemanticLinkList::GetNext(), CFindPathConfig::GetNumNodeVisits(), CFindPathConfig::GetNumResults(), CFindPathConfig::GetQueuePath(), CSemanticLinkList::GetReverseIterator(), LookupConcept(), SemanticID, and CFindPathConfig::SetCurrentPath().

Here is the call graph for this function:

bool COMCSNet::Load (  const std::string &  a_path  )  [inline]

Loads an optimized binary predicates file from disk. Definition at line 43 of file omcsnet.h. References CLinkMap::Load(), CConceptMap::Load(), m_conceptMap, m_linkMap, and m_textIDMap.

Here is the call graph for this function:

bool COMCSNet::LoadPredicateFile (  const std::string &  a_path  )

Loads a raw text predicates file. Definition at line 29 of file omcsnet.cpp. References CPredicateFileIO::CloseInputFile(), CPredicateDecoder::DecodePredicateText(), DPRINT, CPredicateFileIO::GetPredicate(), CLinkMap::GetSize(), CConceptMap::GetSize(), m_conceptMap, m_idFactory, m_linkMap, m_textIDMap, and CPredicateFileIO::OpenInputFile().

Here is the call graph for this function:

CSemanticConcept* COMCSNet::LookupConcept (  const SemanticID  a_id  )  [inline]

Lookup a specific concept using its numeric ID. Definition at line 133 of file omcsnet.h. References CConceptMap::Lookup(), and m_conceptMap.

Here is the call graph for this function:

CSemanticConcept* COMCSNet::LookupConcept (  const std::string &  a_name  )  [inline]

Lookup a specific concept using its textual name. Definition at line 118 of file omcsnet.h. References CConceptMap::Lookup(), CTextIDMap::Lookup(), m_conceptMap, m_textIDMap, and SemanticID. Referenced by FindAnalogous(), FindContext(), and FindPathFromA_To_B().

Here is the call graph for this function:

std::string COMCSNet::LookupString (  const SemanticID  a_id  )

Lookup a string in the TextID Map using a semantic ID. Definition at line 638 of file omcsnet.cpp. References CSemanticConcept::GetName(), CConceptMap::Lookup(), and m_conceptMap.

Here is the call graph for this function:

void COMCSNet::p_AnalogousProcessBackwardLink (  CSemanticLink *  a_link, CFindAnalogousConfig &  a_config, const RelationType  a_relation )  [private]

Process a backwards link during 'Find Analogous' searching. Definition at line 504 of file omcsnet.cpp. References DPRINT, CSemanticConcept::GetName(), CFindAnalogousConfig::GetNodeName(), CSemanticLink::GetSource(), CSemanticLink::GetType(), CFindAnalogousConfig::StoreWeightedLink(), and CFindAnalogousConfig::VisitNode(). Referenced by p_AnalogousProcessBackwardLinkMap().

Here is the call graph for this function:

bool COMCSNet::p_AnalogousProcessBackwardLinkMap (  CLinkMap *  a_linkMap, CFindAnalogousConfig &  a_config, const RelationType  a_relation )  [private]

Process a backwards link map during 'Find Analogous' searching. Definition at line 443 of file omcsnet.cpp. References CFindAnalogousConfig::AllowVisit(), CSemanticLinkMap_i, DPRINT, CLinkMap::GetIterator(), CLinkMap::GetNext(), and p_AnalogousProcessBackwardLink(). Referenced by p_AnalogousProcessLink().

Here is the call graph for this function:

void COMCSNet::p_AnalogousProcessLink (  CSemanticLink *  a_link, CFindAnalogousConfig &  a_config )  [private]

Process a semantic link during 'Find Analogous' searching. Definition at line 475 of file omcsnet.cpp. References CFindAnalogousConfig::AllowVisit(), CSemanticConcept::GetBackwardLinks(), CSemanticLink::GetDest(), CSemanticLink::GetType(), MAX_RELATIONS, p_AnalogousProcessBackwardLinkMap(), RelationType, and CFindAnalogousConfig::VisitNode(). Referenced by p_AnalogousProcessLinkMap().

Here is the call graph for this function:

bool COMCSNet::p_AnalogousProcessLinkMap (  CLinkMap *  a_linkMap, CFindAnalogousConfig &  a_config )  [private]

Process a link map during 'Find Analogous' searching. Definition at line 413 of file omcsnet.cpp. References CFindAnalogousConfig::AllowVisit(), CSemanticLinkMap_i, DPRINT, CLinkMap::GetIterator(), CLinkMap::GetNext(), and p_AnalogousProcessLink(). Referenced by FindAnalogous().

Here is the call graph for this function:

void COMCSNet::p_AnalogousProcessWeightedNode (  CAnalogousWeightNode *  a_node  )  [private]

Process a weighted candidate node during 'Find Analogous' searching. Definition at line 175 of file omcsnet.cpp. References CAnalogousWeightNode::AddWeightValue(), CSemanticLinkMap_i, CAnalogousWeightNode::GetLink(), CAnalogousWeightNode::GetLinkIterator(), CSemanticLink::GetType(), RELATION_LOCATION_OF, RELATION_OFTEN_NEAR, RELATION_PROPERTY_OF, and RELATION_USED_FOR. Referenced by FindAnalogous().

Here is the call graph for this function:

bool COMCSNet::p_FindContextProcessLinkMap (  CLinkMap *  a_linkMap, CFindContextConfig &  a_config, const float  a_oldScore )  [private]

Process a link map during 'Find Context' searching. Definition at line 528 of file omcsnet.cpp. References CFindContextConfig::AllowVisit(), CSemanticLinkMap_i, DPRINT, CSemanticLink::GetDest(), CFindContextConfig::GetDiscountFactor(), CLinkMap::GetIterator(), CLinkMap::GetNext(), CFindContextConfig::QueueScore(), and CFindContextConfig::VisitNode(). Referenced by FindContext().

Here is the call graph for this function:

bool COMCSNet::Save (  const std::string &  a_path  )  [inline]

Saves an optimized binary predicates file to disk. Definition at line 73 of file omcsnet.h. References m_conceptMap, m_linkMap, CLinkMap::Save(), and CConceptMap::Save().

Here is the call graph for this function:

---

Member Data Documentation

CConceptMap COMCSNet::m_conceptMap [private]

Map of semantic concepts. Definition at line 180 of file omcsnet.h. Referenced by FindContext(), Load(), LoadPredicateFile(), LookupConcept(), LookupString(), and Save().

CSemanticIDGenerator COMCSNet::m_idFactory [private]

Generates unique IDs for concepts and semantic links. Definition at line 177 of file omcsnet.h. Referenced by LoadPredicateFile().

CLinkMap COMCSNet::m_linkMap [private]

Map of semantic links. Definition at line 183 of file omcsnet.h. Referenced by Load(), LoadPredicateFile(), and Save().

CTextIDMap COMCSNet::m_textIDMap [private]

Map of TextualName->ID associations for concepts. Definition at line 174 of file omcsnet.h. Referenced by Load(), LoadPredicateFile(), and LookupConcept().

---

The documentation for this class was generated from the following files:

• omcsnet.h
• omcsnet.cpp

---