/*============================================================================

    Copyright (C) 2009 William Hart

    This file is part of FLINT.

    FLINT 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; either version 2 of the License, or
    (at your option) any later version.

    FLINT 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 FLINT; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA

===============================================================================*/

link/fmpz_single.c <-- fmpz.c

   By default, this version of fmpz.c is used (it is copied into place
   by configure). In this case the fmpz module is not threadsafe, though 
   a little faster when using integers which are larger than 
   \code{FLINT_BITS - 2} bits. It stores a growing cache of unused mpz's 
   which can be rationed out as needed.

fmpz

   an fmpz is implemented as an slong. When its second most significant bit 
   is 0 the fmpz represents an ordinary slong integer whose absolute
   value is at most FLINT_BITS - 2 bits.

   When the second most significant bit is 1 then the value represents a 
   pointer (the pointer is shifted right 2 bits and the second msb is set
   to 1 - this relies on the fact that malloc always allocates memory
   blocks on a 4 or 8 byte boundary).

fmpz_t
  
   an array of length 1 of fmpz's. This is used to pass fmpz's around by
   reference without fuss, similar to the way mpz_t's work.

COEFF_MAX
 
   the largest (positive) value an fmpz can be if just an slong

COEFF_MIN
 
   the smallest (negative) value an fmpz can be if just an slong

fmpz PTR_TO_COEFF(__mpz_struct * ptr)

   a macro to convert an mpz_t (or more generally any __mpz_struct *) to an 
   fmpz (shifts the pointer right by 2 and sets the second most significant 
   bit). 

__mpz_struct * COEFF_TO_PTR(fmpz f)

   a macro to convert an fmpz which represents a pointer into an actual 
   pointer to an __mpz_struct (i.e. to an mpz_t)

int COEFF_IS_MPZ(fmpz f)

   a macro which returns 1 if f represents an mpz_t, otherwise 0 is returned.

__mpz_struct * _fmpz_new_mpz(void)

   initialises a new mpz_t and returns a pointer to it. If an mpz is available 
   in the internal cache of mpz's, fmpz_unused_arr, such an mpz is returned, 
   otherwise MPZ_BLOCK more mpz's are allocated and placed into the internal 
   cache and one of these returned. This is only used internally.

void _fmpz_clear_mpz(fmpz f)

   relinquished the mpz associated to f to the internal cache of unused mpz's,
   fmpz_unused_arr. This is only used internally.

void _fmpz_cleanup()

   cleans up the internal stack of mpz's, clearing any unused mpz's.

void _fmpz_cleanup_mpz_content()

   Cleans up the internal stack of mpz's, freeing all allocated limb data,
   but does not free the main arrays of mpz structs. Unlike _fmpz_cleanup,
   it is safe to use fmpz_clear on any remaining fmpz's after
   this function has been called.

__mpz_struct * _fmpz_promote(fmpz_t f)

   if f doesn't represent an mpz_t, initialise one and associate it to f.

__mpz_struct * _fmpz_promote_val(fmpz_t f)

   if f doesn't represent an mpz_t, initialise one and associate it to f, but
   preserve the value of f.

void _fmpz_demote(fmpz_t f)

   if f represents an mpz_t clear it and make f just represent an slong.

void _fmpz_demote_val(fmpz_t f)

   if f represents an mpz_t and its value will fit in an slong, preserve the 
   value in f which we make to represent an slong, and clear the mpz_t.