File : fz_cmp.ads

   1 ------------------------------------------------------------------------------
   2 ------------------------------------------------------------------------------
   3 -- This file is part of 'Finite Field Arithmetic', aka 'FFA'.               --
   4 --                                                                          --
   5 -- (C) 2019 Stanislav Datskovskiy ( www.loper-os.org )                      --
   6 -- http://wot.deedbot.org/17215D118B7239507FAFED98B98228A001ABFFC7.html     --
   7 --                                                                          --
   8 -- You do not have, nor can you ever acquire the right to use, copy or      --
   9 -- distribute this software ; Should you use this software for any purpose, --
  10 -- or copy and distribute it to anyone or in any manner, you are breaking   --
  11 -- the laws of whatever soi-disant jurisdiction, and you promise to         --
  12 -- continue doing so for the indefinite future. In any case, please         --
  13 -- always : read and understand any software ; verify any PGP signatures    --
  14 -- that you use - for any purpose.                                          --
  15 --                                                                          --
  16 -- See also http://trilema.com/2015/a-new-software-licensing-paradigm .     --
  17 ------------------------------------------------------------------------------
  18 ------------------------------------------------------------------------------
  19 
  20 with Words; use Words;
  21 with FZ_Type; use FZ_Type;
  22 
  23 
  24 package FZ_Cmp is
  25    
  26    pragma Pure;
  27    
  28    -------------------------------------------
  29    -- Comparison Predicate Operations on FZ --
  30    -------------------------------------------
  31    
  32    -- 1 iff X == Y (branch-free); else 0
  33    function FZ_EqP(X : in FZ; Y: in FZ) return WBool
  34      with Pre => X'Length = Y'Length;
  35    
  36    -- 1 iff X == W (branch-free); else 0
  37    function FZ_EqP_W(X : in FZ; W : in Word) return WBool;
  38    pragma Inline_Always(FZ_EqP_W);
  39    
  40    -- 1 iff X < Y (branch-free); else 0
  41    function FZ_LessThanP(X : in FZ; Y : in FZ) return WBool
  42      with Pre => X'Length = Y'Length;
  43    
  44    -- 1 iff X > Y (branch-free); else 0
  45    function FZ_GreaterThanP(X : in FZ; Y : in FZ) return WBool
  46      with Pre => X'Length = Y'Length;
  47    
  48 end FZ_Cmp;