imm.h File Reference

operations on immediates, that is elements of F_p, GF, Z, Q that fit into intrinsic int, long More...

#include <stdint.h>
#include <iostream>
#include "cf_assert.h"
#include "cf_defs.h"
#include "cf_globals.h"
#include "ffops.h"
#include "gfops.h"
#include "cf_factory.h"
#include "canonicalform.h"
#include "int_cf.h"

Go to the source code of this file.

Macros
#define	OSTREAM   std::ostream

Functions
static long	imm2int (const InternalCF *const imm)
static InternalCF *	int2imm (long i)
InternalCF *	int2imm_p (long i)
InternalCF *	int2imm_gf (long i)
int	imm_isone (const InternalCF *const ptr)
int	imm_isone_p (const InternalCF *const ptr)
int	imm_isone_gf (const InternalCF *const ptr)
int	imm_iszero (const InternalCF *const ptr)
int	imm_iszero_p (const InternalCF *const ptr)
int	imm_iszero_gf (const InternalCF *const ptr)
long	imm_intval (const InternalCF *const op)
int	imm_sign (const InternalCF *const op)
	imm_sign() - return sign of immediate object. More...
int	imm_cmp (const InternalCF *const lhs, const InternalCF *const rhs)
	imm_cmp(), imm_cmp_p(), imm_cmp_gf() - compare immediate objects. More...
int	imm_cmp_p (const InternalCF *const lhs, const InternalCF *const rhs)
int	imm_cmp_gf (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_add (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_add_p (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_add_gf (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_sub (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_sub_p (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_sub_gf (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_mul (InternalCF *lhs, InternalCF *rhs)
InternalCF *	imm_mul_p (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_mul_gf (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_div (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_divrat (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_div_p (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_div_gf (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_mod (const InternalCF *const lhs, const InternalCF *const rhs)
InternalCF *	imm_mod_p (const InternalCF *const, const InternalCF *const)
InternalCF *	imm_mod_gf (const InternalCF *const, const InternalCF *const)
void	imm_divrem (const InternalCF *const lhs, const InternalCF *const rhs, InternalCF *&q, InternalCF *&r)
void	imm_divrem_p (const InternalCF *const lhs, const InternalCF *const rhs, InternalCF *&q, InternalCF *&r)
void	imm_divrem_gf (const InternalCF *const lhs, const InternalCF *const rhs, InternalCF *&q, InternalCF *&r)
InternalCF *	imm_neg (const InternalCF *const op)
InternalCF *	imm_neg_p (const InternalCF *const op)
InternalCF *	imm_neg_gf (const InternalCF *const op)

Variables
const long	INTMARK = 1
const long	FFMARK = 2
const long	GFMARK = 3
const long	MINIMMEDIATE = -(1L<<60)+2L
const long	MAXIMMEDIATE = (1L<<60)-2L
const FACTORY_INT64	MINIMMEDIATELL = -268435454LL
const FACTORY_INT64	MAXIMMEDIATELL = 268435454LL

Detailed Description

operations on immediates, that is elements of F_p, GF, Z, Q that fit into intrinsic int, long

Definition in file imm.h.

Macro Definition Documentation

OSTREAM

#define OSTREAM   std::ostream

Definition at line 20 of file imm.h.

Function Documentation

imm2int()

static long imm2int ( const InternalCF *const  imm )

inlinestatic

Definition at line 70 of file imm.h.

{
    return ((intptr_t)imm) >> 2;
}

imm_add()

InternalCF * imm_add ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 272 of file imm.h.

{
    long result = imm2int( lhs ) + imm2int( rhs );
    if ( ( result > MAXIMMEDIATE ) || ( result < MINIMMEDIATE ) )
        return CFFactory::basic( result );
    else
        return int2imm( result );
}

imm_add_gf()

InternalCF * imm_add_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 286 of file imm.h.

{
    return int2imm_gf( gf_add( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_add_p()

InternalCF * imm_add_p ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 281 of file imm.h.

{
    return int2imm_p( ff_add( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_cmp()

int imm_cmp ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

imm_cmp(), imm_cmp_p(), imm_cmp_gf() - compare immediate objects.

For immediate integers, it is clear how this should be done. For objects from finite fields, it is not clear since they are not ordered fields. However, since we want to have a total well order on polynomials we have to define a total well order on all coefficients, too. We decided to use simply the order on the representation as `int's of such objects.

See also

CanonicalForm::operator <(), CanonicalForm::operator ==()

Definition at line 237 of file imm.h.

{
    if ( imm2int( lhs ) == imm2int( rhs ) )
        return 0;
    else  if ( imm2int( lhs ) > imm2int( rhs ) )
        return 1;
    else
        return -1;
}

imm_cmp_gf()

int imm_cmp_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 259 of file imm.h.

{
    if ( imm2int( lhs ) == imm2int( rhs ) )
        return 0;
    // check is done in this way because zero should be minimal
    else if ( imm2int( lhs ) > imm2int( rhs ) )
        return -1;
    else
        return 1;
}

imm_cmp_p()

int imm_cmp_p ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 248 of file imm.h.

{
    if ( imm2int( lhs ) == imm2int( rhs ) )
        return 0;
    else if ( imm2int( lhs ) > imm2int( rhs ) )
        return 1;
    else
        return -1;
}

imm_div()

InternalCF * imm_div ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 361 of file imm.h.

{
    long a = imm2int( lhs );
    long b = imm2int( rhs );
    if ( a > 0 )
        return int2imm( a / b );
    else  if ( b > 0 )
        return int2imm( -((b-a-1)/b) );
    else
        return int2imm( (-a-b-1)/(-b) );
}

imm_div_gf()

InternalCF * imm_div_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 394 of file imm.h.

{
    return int2imm_gf( gf_div( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_div_p()

InternalCF * imm_div_p ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 389 of file imm.h.

{
    return int2imm_p( ff_div( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_divrat()

InternalCF * imm_divrat ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 373 of file imm.h.

{
    if ( cf_glob_switches.isOn( SW_RATIONAL ) )
        return CFFactory::rational( imm2int( lhs ), imm2int( rhs ) );
    else {
        long a = imm2int( lhs );
        long b = imm2int( rhs );
        if ( a > 0 )
            return int2imm( a / b );
        else  if ( b > 0 )
            return int2imm( -((b-a-1)/b) );
        else
            return int2imm( (-a-b-1)/(-b) );
    }
}

imm_divrem()

void imm_divrem ( const InternalCF *const  lhs, const InternalCF *const  rhs, InternalCF *&  q, InternalCF *&  r  )

inline

Definition at line 433 of file imm.h.

{
    if ( cf_glob_switches.isOn( SW_RATIONAL ) ) {
        q = imm_divrat( lhs, rhs );
        r = CFFactory::basic( 0L );
    }
    else {
        q = imm_div( lhs, rhs );
        r = imm_mod( lhs, rhs );
    }
}

imm_divrem_gf()

void imm_divrem_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs, InternalCF *&  q, InternalCF *&  r  )

inline

Definition at line 451 of file imm.h.

{
    q = int2imm_gf( gf_div( imm2int( lhs ), imm2int( rhs ) ) );
    r = int2imm_gf( gf_q );
}

imm_divrem_p()

void imm_divrem_p ( const InternalCF *const  lhs, const InternalCF *const  rhs, InternalCF *&  q, InternalCF *&  r  )

inline

Definition at line 445 of file imm.h.

{
    q = int2imm_p( ff_div( imm2int( lhs ), imm2int( rhs ) ) );
    r = int2imm_p( 0 );
}

imm_intval()

long imm_intval ( const InternalCF *const  op )

inline

Definition at line 164 of file imm.h.

{
    if ( is_imm( op ) == FFMARK )
    {
        if ( cf_glob_switches.isOn( SW_SYMMETRIC_FF ) )
            return ff_symmetric( imm2int( op ) );
        else
            return imm2int( op );
    }
    else  if ( is_imm( op ) == GFMARK )
    {
        ASSERT( gf_isff( imm2int( op ) ), "invalid conversion" );
        if ( cf_glob_switches.isOn( SW_SYMMETRIC_FF ) )
            return ff_symmetric( gf_gf2ff( imm2int( op ) ) );
        else
            return gf_gf2ff( imm2int( op ) );
    }
    /*else*/
        return imm2int( op );
}

imm_isone()

int imm_isone ( const InternalCF *const  ptr )

inline

Definition at line 124 of file imm.h.

{
    return imm2int( ptr ) == 1;
}

imm_isone_gf()

int imm_isone_gf ( const InternalCF *const  ptr )

inline

Definition at line 136 of file imm.h.

{
    return gf_isone( imm2int( ptr ) );
}

imm_isone_p()

int imm_isone_p ( const InternalCF *const  ptr )

inline

Definition at line 130 of file imm.h.

{
    return imm2int( ptr ) == 1;
}

imm_iszero()

int imm_iszero ( const InternalCF *const  ptr )

inline

Definition at line 145 of file imm.h.

{
    return imm2int( ptr ) == 0;
}

imm_iszero_gf()

int imm_iszero_gf ( const InternalCF *const  ptr )

inline

Definition at line 157 of file imm.h.

{
    return gf_iszero( imm2int( ptr ) );
}

imm_iszero_p()

int imm_iszero_p ( const InternalCF *const  ptr )

inline

Definition at line 151 of file imm.h.

{
    return imm2int( ptr ) == 0;
}

imm_mod()

InternalCF * imm_mod ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 399 of file imm.h.

{
    if ( cf_glob_switches.isOn( SW_RATIONAL ) )
        return int2imm( 0 );
    else {
        long a = imm2int( lhs );
        long b = imm2int( rhs );
        if ( a > 0 )
            if ( b > 0 )
                return int2imm( a % b );
            else
                return int2imm( a % (-b) );
        else
            if ( b > 0 ) {
                long r = (-a) % b;
                return int2imm( (r==0) ? r : b-r );
            }
            else {
                long r = (-a) % (-b);
                return int2imm( (r==0) ? r : -b-r );
            }
    }
}

imm_mod_gf()

InternalCF * imm_mod_gf ( const InternalCF * const  , const InternalCF * const    )

inline

Definition at line 428 of file imm.h.

{
    return int2imm_gf( gf_q );
}

imm_mod_p()

InternalCF * imm_mod_p ( const InternalCF * const  , const InternalCF * const    )

inline

Definition at line 423 of file imm.h.

{
    return int2imm_p( 0 );
}

imm_mul()

InternalCF * imm_mul ( InternalCF *  lhs, InternalCF *  rhs  )

inline

Definition at line 311 of file imm.h.

{
    long a = imm2int( lhs );
    if (a == 0L)
      return int2imm(0);
    long b = imm2int( rhs );
    int sa= 1;
    unsigned FACTORY_INT64 aa, bb;
    if (a < 0)
    {
      sa= -1;
      aa= (unsigned FACTORY_INT64) (-a);
    }
    else
      aa= (unsigned FACTORY_INT64) a;
    if (b < 0)
    {
      sa= -sa;
      bb= (unsigned FACTORY_INT64) (-b);
    }
    else
      bb= (unsigned FACTORY_INT64) b;
    unsigned FACTORY_INT64 result = aa*bb;
    #if SIZEOF_LONG == 4
    if (result>(unsigned FACTORY_INT64)MAXIMMEDIATE)
    {
        InternalCF * res = CFFactory::basic( IntegerDomain, a, true );
        return res->mulcoeff( rhs );
    }
    #else
    if ( ((result/aa!=bb) || (result>(unsigned FACTORY_INT64) MAXIMMEDIATE) ))
    {
        InternalCF * res = CFFactory::basic( IntegerDomain, a, true );
        return res->mulcoeff( rhs );
    }
    #endif
    else
      return int2imm( sa*result );
}

imm_mul_gf()

InternalCF * imm_mul_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 356 of file imm.h.

{
    return int2imm_gf( gf_mul( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_mul_p()

InternalCF * imm_mul_p ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 351 of file imm.h.

{
    return int2imm_p( ff_mul( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_neg()

InternalCF * imm_neg ( const InternalCF *const  op )

inline

Definition at line 460 of file imm.h.

{
    return int2imm( -imm2int( op ) );
}

imm_neg_gf()

InternalCF * imm_neg_gf ( const InternalCF *const  op )

inline

Definition at line 472 of file imm.h.

{
    return int2imm_gf( gf_neg( imm2int( op ) ) );
}

imm_neg_p()

InternalCF * imm_neg_p ( const InternalCF *const  op )

inline

Definition at line 466 of file imm.h.

{
    return int2imm_p( ff_neg( imm2int( op ) ) );
}

imm_sign()

int imm_sign ( const InternalCF *const  op )

inline

imm_sign() - return sign of immediate object.

If CO is an immediate integer, the sign is defined as usual. If CO is an element of FF(p) and SW_SYMMETRIC_FF is on the sign of CO is the sign of the symmetric representation of CO. If CO is in GF(q) or in FF(p) and SW_SYMMETRIC_FF is off, the sign of CO is zero iff CO is zero, otherwise the sign is one.

See also

CanonicalForm::sign(), gf_sign()

Definition at line 200 of file imm.h.

{
    if ( is_imm( op ) == FFMARK )
        if ( imm2int( op ) == 0 )
            return 0;
        else  if ( cf_glob_switches.isOn( SW_SYMMETRIC_FF ) )
            if ( ff_symmetric( imm2int( op ) ) > 0 )
                return 1;
            else
                return -1;
        else
            return 1;
    else  if ( is_imm( op ) == GFMARK )
        return gf_sign( imm2int( op ) );
    else  if ( imm2int( op ) == 0 )
        return 0;
    else  if ( imm2int( op ) > 0 )
        return 1;
    else
        return -1;
}

imm_sub()

InternalCF * imm_sub ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 291 of file imm.h.

{
    long result = imm2int( lhs ) - imm2int( rhs );
    if ( ( result > MAXIMMEDIATE ) || ( result < MINIMMEDIATE ) )
        return CFFactory::basic( result );
    else
        return int2imm( result );
}

imm_sub_gf()

InternalCF * imm_sub_gf ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 305 of file imm.h.

{
    return int2imm_gf( gf_sub( imm2int( lhs ), imm2int( rhs ) ) );
}

imm_sub_p()

InternalCF * imm_sub_p ( const InternalCF *const  lhs, const InternalCF *const  rhs  )

inline

Definition at line 300 of file imm.h.

{
    return int2imm_p( ff_sub( imm2int( lhs ), imm2int( rhs ) ) );
}

int2imm()

static InternalCF * int2imm ( long  i )

inlinestatic

Definition at line 75 of file imm.h.

{
    return (InternalCF*)((i << 2) | INTMARK );
}

int2imm_gf()

InternalCF * int2imm_gf ( long  i )

inline

Definition at line 106 of file imm.h.

{
    return (InternalCF*)((i << 2) | GFMARK );
}

int2imm_p()

InternalCF * int2imm_p ( long  i )

inline

Definition at line 101 of file imm.h.

{
    return (InternalCF*)((i << 2) | FFMARK );
}

Variable Documentation

FFMARK

const long FFMARK = 2

Definition at line 38 of file imm.h.

GFMARK

const long GFMARK = 3

Definition at line 39 of file imm.h.

INTMARK

const long INTMARK = 1

Definition at line 37 of file imm.h.

MAXIMMEDIATE

const long MAXIMMEDIATE = (1L<<60)-2L

Definition at line 55 of file imm.h.

MAXIMMEDIATELL

const FACTORY_INT64 MAXIMMEDIATELL = 268435454LL

Definition at line 63 of file imm.h.

MINIMMEDIATE

const long MINIMMEDIATE = -(1L<<60)+2L

Definition at line 54 of file imm.h.

MINIMMEDIATELL

const FACTORY_INT64 MINIMMEDIATELL = -268435454LL

Definition at line 62 of file imm.h.