knowrob::ModalOperator Class Reference

#include <ModalOperator.h>

Public Member Functions
	ModalOperator (ModalType modalType)
bool	operator== (const ModalOperator &other) const
bool	isModalNecessity () const
bool	isModalPossibility () const
auto	modalType () const
const char *	symbol () const
void	setParameter (std::string_view key, const TermPtr &value)
std::optional< TermPtr >	parameter (std::string_view key) const
std::optional< PerspectivePtr >	perspective () const
void	setPerspective (const std::string_view &agent)
std::optional< double >	confidence () const
void	setConfidence (double confidence)
std::optional< double >	begin () const
void	setBegin (double begin)
std::optional< double >	end () const
void	setEnd (double end)
void	setTimeInterval (const TimeInterval &timeInterval)
void	write (std::ostream &os) const
	ModalOperator (ModalType modalType)
bool	operator== (const ModalOperator &other) const
bool	isModalNecessity () const
bool	isModalPossibility () const
auto	modalType () const
const char *	symbol () const
void	setParameter (std::string_view key, const TermPtr &value)
std::optional< TermPtr >	parameter (std::string_view key) const
std::optional< PerspectivePtr >	perspective () const
void	setPerspective (const std::string_view &agent)
std::optional< double >	confidence () const
void	setConfidence (double confidence)
std::optional< double >	begin () const
void	setBegin (double begin)
std::optional< double >	end () const
void	setEnd (double end)
void	setTimeInterval (const TimeInterval &timeInterval)
void	write (std::ostream &os) const

Static Public Attributes
static constexpr const char *	KEY_PERSPECTIVE = "agent"
static constexpr const char *	KEY_CONFIDENCE = "confidence"
static constexpr const char *	KEY_BEGIN = "begin"
static constexpr const char *	KEY_END = "end"

Protected Attributes
const ModalType	modalType_
std::map< std::string, TermPtr >	parameters_

Detailed Description

An operator of a modal language, e.g. "B" is often used for "belief" and "K" for "knowledge". Additional parameters can be added to the operator, e.g. "B[confidence=0.8]".

Definition at line 31 of file ModalOperator.h.

Constructor & Destructor Documentation

ModalOperator() [1/2]

ModalOperator::ModalOperator ( ModalType  modalType )

explicit

Parameters

modalType

the type of this operator.

Definition at line 13 of file ModalOperator.cpp.

        : modalType_(modalType) {
}

ModalOperator() [2/2]

knowrob::ModalOperator::ModalOperator ( ModalType  modalType )

explicit

Parameters

modalType

the type of this operator.

Member Function Documentation

begin() [1/2]

std::optional< double > ModalOperator::begin

(

)

const

Returns

the time interval begin parameter of this operator if any.

Definition at line 113 of file ModalOperator.cpp.

                                               {
    auto it = parameters_.find(KEY_BEGIN);
    if (it != parameters_.end() && it->second->isNumeric()) {
        return std::static_pointer_cast<Numeric>(it->second)->asDouble();
    }
    return std::nullopt;
}

begin() [2/2]

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

(

)

const

Returns

the time interval begin parameter of this operator if any.

confidence() [1/2]

std::optional< double > ModalOperator::confidence

(

)

const

Returns

the confidence parameter of this operator if any.

Definition at line 101 of file ModalOperator.cpp.

                                                    {
    auto it = parameters_.find(KEY_CONFIDENCE);
    if (it != parameters_.end() && it->second->isNumeric()) {
        return std::static_pointer_cast<Numeric>(it->second)->asDouble();
    }
    return std::nullopt;
}

confidence() [2/2]

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

(

)

const

Returns

the confidence parameter of this operator if any.

end() [1/2]

std::optional< double > ModalOperator::end

(

)

const

Returns

the time interval end parameter of this operator if any.

Definition at line 125 of file ModalOperator.cpp.

                                             {
    auto it = parameters_.find(KEY_END);
    if (it != parameters_.end() && it->second->isNumeric()) {
        return std::static_pointer_cast<Numeric>(it->second)->asDouble();
    }
    return std::nullopt;
}

end() [2/2]

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

(

)

const

Returns

the time interval end parameter of this operator if any.

isModalNecessity() [1/2]

bool ModalOperator::isModalNecessity

(

)

const

Returns

true if this operator is a necessity operator.

Definition at line 61 of file ModalOperator.cpp.

                                           {
    switch (modalType_) {
        case ModalType::KNOWLEDGE:
        case ModalType::ALWAYS:
            return true;
        case ModalType::SOMETIMES:
        case ModalType::BELIEF:
            return false;
    }
    return true;
}

isModalNecessity() [2/2]

bool knowrob::ModalOperator::isModalNecessity

(

)

const

Returns

true if this operator is a necessity operator.

isModalPossibility() [1/2]

bool ModalOperator::isModalPossibility

(

)

const

Returns

true if this operator is a possibility operator.

Definition at line 73 of file ModalOperator.cpp.

                                             {
    return !isModalNecessity();
}

isModalPossibility() [2/2]

bool knowrob::ModalOperator::isModalPossibility

(

)

const

Returns

true if this operator is a possibility operator.

modalType() [1/2]

auto knowrob::ModalOperator::modalType ( ) const

inline

Returns

the type of this operator.

Definition at line 62 of file ModalOperator.h.

{ return modalType_; }

modalType() [2/2]

auto knowrob::ModalOperator::modalType ( ) const

inline

Returns

the type of this operator.

Definition at line 62 of file ModalOperator.h.

{ return modalType_; }

operator==() [1/2]

bool ModalOperator::operator==

(

const ModalOperator &

other

)

const

Parameters

other

another operator.

Returns

true if this and other are the same operators.

Definition at line 45 of file ModalOperator.cpp.

                                                               {
    if (modalType_ != other.modalType_) {
        return false;
    }
    if (parameters_.size() != other.parameters_.size()) {
        return false;
    }
    for (auto &pair: parameters_) {
        auto it = other.parameters_.find(pair.first);
        if (it == other.parameters_.end() || *it->second != *pair.second) {
            return false;
        }
    }
    return true;
}

operator==() [2/2]

bool knowrob::ModalOperator::operator==

(

const ModalOperator &

other

)

const

Parameters

other

another operator.

Returns

true if this and other are the same operators.

parameter() [1/2]

std::optional< TermPtr > ModalOperator::parameter

(

std::string_view

key

)

const

Parameters

key	the key of the parameter.

Returns

the value of the parameter if any or else null-opt.

Definition at line 81 of file ModalOperator.cpp.

                                                                      {
    auto it = parameters_.find(key.data());
    if (it == parameters_.end()) {
        return std::nullopt;
    }
    return it->second;
}

parameter() [2/2]

std::optional<TermPtr> knowrob::ModalOperator::parameter

(

std::string_view

key

)

const

Parameters

key	the key of the parameter.

Returns

the value of the parameter if any or else null-opt.

perspective() [1/2]

std::optional< PerspectivePtr > ModalOperator::perspective

(

)

const

Returns

the perspective parameter of this operator if any.

Definition at line 89 of file ModalOperator.cpp.

                                                             {
    auto it = parameters_.find(KEY_PERSPECTIVE);
    if (it != parameters_.end() && it->second->isAtom()) {
        return Perspective::get(std::static_pointer_cast<Atomic>(it->second)->stringForm());
    }
    return std::nullopt;
}

perspective() [2/2]

std::optional<PerspectivePtr> knowrob::ModalOperator::perspective

(

)

const

Returns

the perspective parameter of this operator if any.

setBegin() [1/2]

void ModalOperator::setBegin

(

double

begin

)

Parameters

begin

the time interval begin parameter of this operator.

Definition at line 121 of file ModalOperator.cpp.

                                         {
    parameters_[KEY_BEGIN] = std::make_shared<Double>(begin);
}

setBegin() [2/2]

void knowrob::ModalOperator::setBegin

(

double

begin

)

Parameters

begin

the time interval begin parameter of this operator.

setConfidence() [1/2]

void ModalOperator::setConfidence

(

double

confidence

)

Parameters

confidence

the confidence parameter of this operator.

Definition at line 109 of file ModalOperator.cpp.

                                                   {
    parameters_[KEY_CONFIDENCE] = std::make_shared<Double>(confidence);
}

setConfidence() [2/2]

void knowrob::ModalOperator::setConfidence

(

double

confidence

)

Parameters

confidence

the confidence parameter of this operator.

setEnd() [1/2]

void ModalOperator::setEnd

(

double

end

)

Parameters

end	the time interval end parameter of this operator.

Definition at line 133 of file ModalOperator.cpp.

                                     {
    parameters_[KEY_END] = std::make_shared<Double>(end);
}

setEnd() [2/2]

void knowrob::ModalOperator::setEnd

(

double

end

)

Parameters

end	the time interval end parameter of this operator.

setParameter() [1/2]

void ModalOperator::setParameter	(	std::string_view	key,
		const TermPtr &	value
	)

Parameters

key	the key of the parameter.
value	the value of the parameter.

Definition at line 77 of file ModalOperator.cpp.

                                                                         {
    parameters_[key.data()] = value;
}

setParameter() [2/2]

void knowrob::ModalOperator::setParameter	(	std::string_view	key,
		const TermPtr &	value
	)

Parameters

key	the key of the parameter.
value	the value of the parameter.

setPerspective() [1/2]

void ModalOperator::setPerspective

(

const std::string_view &

agent

)

Parameters

agent

the perspective parameter of this operator.

Definition at line 97 of file ModalOperator.cpp.

                                                              {
    parameters_[KEY_PERSPECTIVE] = Atom::Tabled(agent);
}

setPerspective() [2/2]

void knowrob::ModalOperator::setPerspective

(

const std::string_view &

agent

)

Parameters

agent

the perspective parameter of this operator.

setTimeInterval() [1/2]

void ModalOperator::setTimeInterval

(

const TimeInterval &

timeInterval

)

Returns

the time interval parameter of this operator if any.

Definition at line 137 of file ModalOperator.cpp.

                                                                    {
    if (timeInterval.since()) {
        setBegin(time::toSeconds(*timeInterval.since()));
    }
    if (timeInterval.until()) {
        setEnd(time::toSeconds(*timeInterval.until()));
    }
}

setTimeInterval() [2/2]

void knowrob::ModalOperator::setTimeInterval

(

const TimeInterval &

timeInterval

)

Returns

the time interval parameter of this operator if any.

symbol() [1/2]

const char * ModalOperator::symbol

(

)

const

Returns

the symbol of this modal operator.

Definition at line 17 of file ModalOperator.cpp.

                                        {
    switch (modalType_) {
        case ModalType::KNOWLEDGE:
            return "K";
        case ModalType::BELIEF:
            return "B";
        case ModalType::ALWAYS:
            return "H";
        case ModalType::SOMETIMES:
            return "P";
    }
    return "K";
}

symbol() [2/2]

const char* knowrob::ModalOperator::symbol

(

)

const

Returns

the symbol of this modal operator.

write() [1/2]

void ModalOperator::write

(

std::ostream &

os

)

const

Parameters

os	the output stream.

Definition at line 31 of file ModalOperator.cpp.

                                              {
    os << symbol();
 
    if (!parameters_.empty()) {
        os << '[';
        int paramIndex = 0;
        for (auto &pair: parameters_) {
            if (paramIndex++ > 0) os << ", ";
            os << pair.first << '=' << *pair.second;
        }
        os << ']';
    }
}

write() [2/2]

void knowrob::ModalOperator::write

(

std::ostream &

os

)

const

Parameters

os	the output stream.

Member Data Documentation

KEY_BEGIN

static constexpr const char * knowrob::ModalOperator::KEY_BEGIN = "begin"

staticconstexpr

Definition at line 35 of file ModalOperator.h.

KEY_CONFIDENCE

static constexpr const char * knowrob::ModalOperator::KEY_CONFIDENCE = "confidence"

staticconstexpr

Definition at line 34 of file ModalOperator.h.

KEY_END

static constexpr const char * knowrob::ModalOperator::KEY_END = "end"

staticconstexpr

Definition at line 36 of file ModalOperator.h.

KEY_PERSPECTIVE

static constexpr const char * knowrob::ModalOperator::KEY_PERSPECTIVE = "agent"

staticconstexpr

Definition at line 33 of file ModalOperator.h.

modalType_

const ModalType knowrob::ModalOperator::modalType_

protected

Definition at line 132 of file ModalOperator.h.

parameters_

std::map< std::string, TermPtr > knowrob::ModalOperator::parameters_

protected

Definition at line 133 of file ModalOperator.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/formulas/ModalOperator.h
• src/formulas/ModalOperator.cpp