Fuzion Logo
flang.dev — The Fuzion Language Portal
JavaScript seems to be disabled. Functionality is limited.

ordered.fz


# This file is part of the Fuzion language implementation.
#
# The Fuzion language implementation is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation, version 3 of the License.
#
# The Fuzion language implementation is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License along with The
# Fuzion language implementation.  If not, see <https://www.gnu.org/licenses/>.


# -----------------------------------------------------------------------
#
#  Tokiwa Software GmbH, Germany
#
#  Source code of Fuzion standard library feature ordered
#
#  Author: Fridtjof Siebert (siebert@tokiwa.software)
#
# -----------------------------------------------------------------------

# ordered -- feature for immutable values that have an infix <= function
# predicate that defines a total order
#
# features inheriting from ordered define a total order of their values
#
# NYI: the compiler should check that features inheriting from this are
# actually immutable.
#
ordered(O (ordered O).type) : partiallyOrdered O

/* NYI: quantor intrinsics not supported yet:

  inv
    analysis: quantors.forAll2 T T fun(a, b T) => a <= b || b <= a,
*/

is

  # does this come strictly after other?
  #
  infix >  (other O) bool is !(orderedThis <= other)

  # does this come strictly before other?
  #
  infix <  (other O) bool is  !(orderedThis >= other)

  # does this come after other?
  #
  infix >= (other O) bool is other <= orderedThis

  # three-way comparison between this and other.
  #
  # result is < 0 if this < other
  # result is > 0 if this > other
  # result is = 0 if this = other
  #
  infix <> (other O) i32 is
    if      orderedThis < other then -1
    else if orderedThis > other then +1
    else                        0