order.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 order
#
# -----------------------------------------------------------------------

# less -- unit feature to denote the result of a comparison
#
public less is

# greater -- unit feature to denote the result of a comparison
#
public greater is

# equal -- unit feature to denote the result of a comparison
#
public equal is


# choice of less, greater or equal
#
public order : choice less greater equal, property.equatable is

  # maps order to a number
  #
  # less => -1
  # greater => +1
  # equal => 0
  #
  public sign i32 =>
    match order.this
      less => -1
      greater => +1
      equal => 0


  # the value of this order is `less`
  #
  public is_less bool =>
    match order.this
      less => true
      * => false

  # the value of this order is `greater`
  #
  public is_greater bool =>
    match order.this
      greater => true
      * => false

  # the value of this order is `equal`
  #
  public is_equal bool =>
    match order.this
      equal => true
      * => false

  # the value of this order is `greater` or `equal`
  #
  public is_greater_or_equal bool =>
    match order.this
      less => false
      * => true

  # the value of this order is `less` or `equal`
  #
  public is_less_or_equal bool =>
    match order.this
      greater => false
      * => true

  # the value of this order is `unequal`
  #
  public is_unequal bool =>
    match order.this
      equal => false
      * => true



  public fixed redef type.equality(a, b order) bool =>
    match a
      less =>
        match b
          less => true
          * => false
      greater =>
        match b
          greater => true
          * => false
      equal =>
        match b
          equal => true
          * => false



  # human readable string of this choice
  #
  public redef as_string String =>
    match order.this
      less => "less"
      greater => "greater"
      equal => "equal"