summaryrefslogtreecommitdiff
path: root/fuzzylite/fl/term/Binary.h
diff options
context:
space:
mode:
Diffstat (limited to 'fuzzylite/fl/term/Binary.h')
-rw-r--r--fuzzylite/fl/term/Binary.h132
1 files changed, 132 insertions, 0 deletions
diff --git a/fuzzylite/fl/term/Binary.h b/fuzzylite/fl/term/Binary.h
new file mode 100644
index 0000000..c22a9e1
--- /dev/null
+++ b/fuzzylite/fl/term/Binary.h
@@ -0,0 +1,132 @@
+/*
+ fuzzylite (R), a fuzzy logic control library in C++.
+ Copyright (C) 2010-2017 FuzzyLite Limited. All rights reserved.
+ Author: Juan Rada-Vilela, Ph.D. <jcrada@fuzzylite.com>
+
+ This file is part of fuzzylite.
+
+ fuzzylite is free software: you can redistribute it and/or modify it under
+ the terms of the FuzzyLite License included with the software.
+
+ You should have received a copy of the FuzzyLite License along with
+ fuzzylite. If not, see <http://www.fuzzylite.com/license/>.
+
+ fuzzylite is a registered trademark of FuzzyLite Limited.
+ */
+
+#ifndef FL_BINARY_H
+#define FL_BINARY_H
+
+#include "fl/term/Term.h"
+
+namespace fl {
+
+ /**
+ The Binary class is an edge Term that represents the binary membership
+ function.
+
+ @image html binary.svg
+
+ @author Juan Rada-Vilela, Ph.D.
+ @see Term
+ @see Variable
+ @since 6.0
+ */
+ class FL_API Binary : public Term {
+ private:
+ scalar _start;
+ scalar _direction;
+ public:
+
+ /**
+ Direction is an enumerator that indicates the direction of the
+ edge.
+ */
+ enum Direction {
+ /** `(_|)` increases to the right (infinity)*/
+ Positive,
+ /** `(--)` direction is NaN */
+ Undefined,
+ /** `(|_)` increases to the left (-infinity)*/
+ Negative
+ };
+
+ explicit Binary(const std::string& name = "", scalar start = fl::nan,
+ scalar direction = fl::nan, scalar height = 1.0);
+ virtual ~Binary() FL_IOVERRIDE;
+ FL_DEFAULT_COPY_AND_MOVE(Binary)
+
+ virtual std::string className() const FL_IOVERRIDE;
+ /**
+ Returns the parameters of the term
+ @return `"start direction [height]"`
+ */
+ virtual std::string parameters() const FL_IOVERRIDE;
+ /**
+ Configures the term with the parameters
+ @param parameters as `"start direction [height]"`
+ */
+ virtual void configure(const std::string& parameters) FL_IOVERRIDE;
+
+ virtual Complexity complexity() const FL_IOVERRIDE;
+
+ /**
+ Computes the membership function evaluated at @f$x@f$
+ @param x
+ @return @f$\begin{cases}
+ 1h & \mbox{if $ \left(s < d \vedge x \in [s, d)\right) \wedge
+ \left( s > d \vedge x \in (d, s] \right) $} \cr
+ 0h & \mbox{otherwise}
+ \end{cases}@f$
+
+ where @f$h@f$ is the height of the Term,
+ @f$s@f$ is the start of the Binary edge,
+ @f$d@f$ is the direction of the Binary edge.
+ */
+ virtual scalar membership(scalar x) const FL_IOVERRIDE;
+
+ /**
+ Sets the start of the binary edge
+ @param start is the start of the binary edge
+ */
+ virtual void setStart(scalar start);
+ /**
+ Gets the start of the binary edge
+ @return the start of the binary edge
+ */
+ virtual scalar getStart() const;
+
+ /**
+ Sets the direction of the binary edge.
+
+ @f$\begin{cases}
+ \text{Positive} & \mbox{if $ d > s $}\cr
+ \text{Negative} & \mbox{if $ d < s $}\cr
+ \mbox{\tt NaN} & \mbox{otherwise}
+ \end{cases}
+ @f$
+
+ where @f$d@f$ is the given direction, and
+ @f$s@f$ is the start of the Binary edge
+
+ @param direction is the direction of the binary edge
+ */
+ virtual void setDirection(scalar direction);
+ /**
+ Gets the direction of the binary edge
+ @return the direction of the binary edge
+ */
+ virtual scalar getDirection() const;
+
+ /**
+ Gets the Direction of the binary edge as an enumerator
+ @return the Direction of the binary edge as an enumerator
+ */
+ virtual Direction direction() const;
+
+ virtual Binary* clone() const FL_IOVERRIDE;
+
+ static Term* constructor();
+ };
+}
+#endif /* FL_BINARY_H */