------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- This file is part of 'Finite Field Arithmetic', aka 'FFA'.               --
--                                                                          --
-- (C) 2019 Stanislav Datskovskiy ( www.loper-os.org )                      --
-- http://wot.deedbot.org/17215D118B7239507FAFED98B98228A001ABFFC7.html     --
--                                                                          --
-- You do not have, nor can you ever acquire the right to use, copy or      --
-- distribute this software ; Should you use this software for any purpose, --
-- or copy and distribute it to anyone or in any manner, you are breaking   --
-- the laws of whatever soi-disant jurisdiction, and you promise to         --
-- continue doing so for the indefinite future. In any case, please         --
-- always : read and understand any software ; verify any PGP signatures    --
-- that you use - for any purpose.                                          --
--                                                                          --
-- See also http://trilema.com/2015/a-new-software-licensing-paradigm .     --
------------------------------------------------------------------------------
------------------------------------------------------------------------------

with FZ_Type; use FZ_Type;


package FZ_Sqr is
   
   pragma Pure;
   
   -- Karatsuba Threshhold - at or below this many Words, we use Comba mult.
   Sqr_Karatsuba_Thresh : constant Indices := 8;
   
   -- Square. (CAUTION: UNBUFFERED)
   procedure FZ_Square_Unbuffered(X     : in  FZ;
                                  XX    : out FZ);
   pragma Inline_Always(FZ_Square_Unbuffered);
   
   -- Comba's squaring. (CAUTION: UNBUFFERED)
   procedure FZ_Sqr_Comba(X     : in  FZ;
                          XX    : out FZ);
   pragma Inline_Always(FZ_Sqr_Comba);
   
   -- Karatsuba's Squaring. (CAUTION: UNBUFFERED)
   procedure Sqr_Karatsuba(X  : in  FZ;
                           XX : out FZ)
     with Pre => XX'Length = 2 * X'Length and
     X'Length mod 2 = 0;
   -- CAUTION: Inlining prohibited for Sqr_Karatsuba !
   
   -- Squaring. Preserves the inputs.
   procedure FZ_Square_Buffered(X     : in  FZ;
                                XX_Lo : out FZ;
                                XX_Hi : out FZ);
   pragma Inline_Always(FZ_Square_Buffered);
   
end FZ_Sqr;