knowrob::GraphSelector Struct Reference

#include <GraphSelector.h>

Inheritance diagram for knowrob::GraphSelector:

Collaboration diagram for knowrob::GraphSelector:

Public Member Functions
	GraphSelector ()=default
size_t	hash () const
bool	mergeWith (const GraphSelector &other)
void	set (const boost::property_tree::ptree &config)
void	write (std::ostream &os) const override
	GraphSelector ()=default
size_t	hash () const
bool	mergeWith (const GraphSelector &other)
void	set (const boost::property_tree::ptree &config)
void	write (std::ostream &os) const override
Public Member Functions inherited from knowrob::Printable
virtual	~Printable ()=default
virtual std::string	format () const
virtual	~Printable ()=default
virtual std::string	format () const

Public Attributes
AtomPtr	graph
PerspectivePtr	perspective
bool	occasional = false
bool	uncertain = false
std::optional< double >	begin
std::optional< double >	end
std::optional< double >	confidence

Detailed Description

The data base can contain multiple graphs, and this selector is used to select a subset of them. For example, each point in time is conceptually a separate graph, and a query may only address a specific point in time, or time interval.

Definition at line 20 of file GraphSelector.h.

Constructor & Destructor Documentation

GraphSelector() [1/2]

knowrob::GraphSelector::GraphSelector ( )

default

GraphSelector() [2/2]

knowrob::GraphSelector::GraphSelector ( )

default

Member Function Documentation

hash() [1/2]

size_t GraphSelector::hash

(

)

const

Compute the hash value of this selector.

Returns

the hash value

Definition at line 54 of file GraphSelector.cpp.

                                 {
    size_t val = 0;
    if (graph) {
        hashCombine(val, graph->hash());
    } else {
        hashCombine(val, 0);
    }
    if (perspective) {
        hashCombine(val, std::hash<std::string_view>{}(perspective->iri()));
    } else {
        hashCombine(val, 0);
    }
    hashCombine(val, std::hash<bool>{}(occasional));
    hashCombine(val, std::hash<bool>{}(uncertain));
    hashCombine(val, std::hash<std::optional<double>>{}(end));
    hashCombine(val, std::hash<std::optional<double>>{}(begin));
    hashCombine(val, std::hash<std::optional<double>>{}(confidence));
    return val;
}

hash() [2/2]

size_t knowrob::GraphSelector::hash

(

)

const

Compute the hash value of this selector.

Returns

the hash value

mergeWith() [1/2]

bool GraphSelector::mergeWith

(

const GraphSelector &

other

)

Merge this selector with another selector.

Parameters

other

another selector.

Returns

true if the merge was successful.

Definition at line 13 of file GraphSelector.cpp.

                                                        {
    uncertain = uncertain || other.uncertain;
    occasional = occasional || other.occasional;
 
    // graph selector changes to wildcard if graph of the other selector is different
    if (!graph || !other.graph || *graph != *other.graph) {
        graph = nullptr;
    }
 
    // agent cannot be changed in merge operation.
    // So GraphSelector can only be merged within a modal in which both are embedded.
    if (perspective) {
        if (other.perspective) {
            if (perspective->iri() != other.perspective->iri()) {
                return false;
            }
        } else {
            return false;
        }
    } else if (other.perspective) {
        return false;
    }
 
    // later begin time is more restrictive
    if (other.begin.has_value() && (!begin.has_value() || other.begin.value() > begin.value())) {
        begin = other.begin;
    }
 
    // earlier end time is more restrictive
    if (other.end.has_value() && (!end.has_value() || other.end.value() > end.value())) {
        end = other.end;
    }
 
    // smaller confidence is more restrictive
    if (other.confidence.has_value() && (!confidence.has_value() || other.confidence.value() < confidence.value())) {
        confidence = other.confidence;
    }
 
    return true;
}

mergeWith() [2/2]

bool knowrob::GraphSelector::mergeWith

(

const GraphSelector &

other

)

Merge this selector with another selector.

Parameters

other

another selector.

Returns

true if the merge was successful.

set() [1/2]

void GraphSelector::set

(

const boost::property_tree::ptree &

config

)

Set the selector from a property tree.

Parameters

config

the property tree

Definition at line 117 of file GraphSelector.cpp.

                                                             {
    uncertain = config.get<bool>("uncertain", false);
    occasional = config.get<bool>("occasional", false);
    if (config.count("graph")) {
        graph = Atom::Tabled(config.get<std::string>("graph"));
    }
    if (config.count("perspective")) {
        perspective = std::make_shared<Perspective>(config.get<std::string>("perspective"));
    }
    if (config.count("begin")) {
        begin = config.get<double>("begin");
    }
    if (config.count("end")) {
        end = config.get<double>("end");
    }
    if (config.count("confidence")) {
        confidence = config.get<double>("confidence");
    }
}

set() [2/2]

void knowrob::GraphSelector::set

(

const boost::property_tree::ptree &

config

)

Set the selector from a property tree.

Parameters

config

the property tree

write() [1/2]

void GraphSelector::write ( std::ostream &  os ) const

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Definition at line 74 of file GraphSelector.cpp.

                                              {
    os << std::setprecision(1);
 
    bool hasEpistemicOperator = false;
    if (confidence.has_value()) {
        hasEpistemicOperator = true;
        if (confidence.value() > 0.999) {
            os << 'K';
        } else {
            os << "B[" << confidence.value() << "]";
        }
    } else if (uncertain) {
        hasEpistemicOperator = true;
        os << 'B';
    }
    if (perspective && !Perspective::isEgoPerspective(perspective->iri())) {
        if (!hasEpistemicOperator) {
            os << 'K';
        }
        os << '[' << perspective->iri() << ']';
    }
 
    bool hasTemporalOperator = false;
    if (occasional) {
        hasTemporalOperator = true;
        os << 'P';
    }
    if (begin.has_value() || end.has_value()) {
        if (!hasTemporalOperator) {
            os << 'H';
        }
        os << '[';
        if (begin.has_value()) {
            os << begin.value();
        }
        os << '-';
        if (end.has_value()) {
            os << end.value();
        }
        os << ']';
    }
}

write() [2/2]

void knowrob::GraphSelector::write ( std::ostream &  os ) const

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Member Data Documentation

begin

std::optional< double > knowrob::GraphSelector::begin

The begin of the time interval of consideration.

Definition at line 42 of file GraphSelector.h.

confidence

std::optional< double > knowrob::GraphSelector::confidence

The minimum confidence threshold for statements.

Definition at line 50 of file GraphSelector.h.

end

std::optional< double > knowrob::GraphSelector::end

The end of the time interval of consideration.

Definition at line 46 of file GraphSelector.h.

graph

AtomPtr knowrob::GraphSelector::graph

The name of the graph, usually reflects the name of an ontology.

Definition at line 26 of file GraphSelector.h.

occasional

bool knowrob::GraphSelector::occasional = false

True if occasional triples are considered.

Definition at line 34 of file GraphSelector.h.

perspective

PerspectivePtr knowrob::GraphSelector::perspective

The perspective of statement.

Definition at line 30 of file GraphSelector.h.

uncertain

bool knowrob::GraphSelector::uncertain = false

True if uncertain triples are considered.

Definition at line 38 of file GraphSelector.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/semweb/GraphSelector.h
• src/semweb/GraphSelector.cpp