kernel-types.hh

Go to the documentation of this file.

/*
 * lib-gmapkernel : Un noyau de 3-G-cartes et des opérations.
 * Copyright (C) 2004, Moka Team, Université de Poitiers, Laboratoire SIC
 *               http://www.sic.sp2mi.univ-poitiers.fr/
 * Copyright (C) 2009, Guillaume Damiand, CNRS, LIRIS,
 *               guillaume.damiand@liris.cnrs.fr, http://liris.cnrs.fr/
 *
 * This file is part of lib-gmapkernel
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

//******************************************************************************
#ifndef KERNEL_TYPES_HH
#define KERNEL_TYPES_HH
//******************************************************************************
#include "attributes-id.hh"
#include "alt-stdint.hh"

#include <bitset>
#include <string>
//******************************************************************************
//******************************************************************************
// @name Macros
// @{

#define NB_MARKS (32)

#define NB_DIRECT_INFO (4)

// @}

//******************************************************************************
typedef int8_t TOrbit;

// @name Orbites de base
// @{
enum
{
  ORBIT_NONE = -1,
  ORBIT_SELF,   
  ORBIT_0,
  ORBIT_1,
  ORBIT_01,
  ORBIT_2,
  ORBIT_02,
  ORBIT_12,
  ORBIT_012,
  ORBIT_3,
  ORBIT_03,
  ORBIT_13,
  ORBIT_013,
  ORBIT_23,
  ORBIT_023,
  ORBIT_123,
  ORBIT_0123,

  ORBIT_BORDER_0,
  ORBIT_BORDER_1,
  ORBIT_BORDER_2,
  ORBIT_BORDER_3
};

// @}
//******************************************************************************
// @name Types d'attributs
// @{

typedef int TAttributeId;


// @}
//******************************************************************************
// @{

#define NEG_ORBIT(O1) \
    (static_cast<TOrbit> (0xF ^ (static_cast<unsigned int>(O1))))

#define ADD_ORBIT(O1,O2) \
    (static_cast<TOrbit>( \
     static_cast<unsigned int>(O1) | \
     static_cast<unsigned int>(O2)))

#define AND_ORBIT(O1,O2) \
    (static_cast<TOrbit>( \
     static_cast<unsigned int>(O1) & \
     static_cast<unsigned int>(O2)))

#define SUB_ORBIT(O1,O2) \
    (static_cast<TOrbit>( \
     static_cast<unsigned int>(O1) & \
     static_cast<unsigned int>(NEG_ORBIT(O2))))

#define IS_ORBIT_INCLUDED(O1,O2) \
    (static_cast<TOrbit>( \
     static_cast<unsigned int>(O1) & \
     static_cast<unsigned int>(O2)) == O1)

// @}
//****************************************************************************
// @name Orbites ayant une sémantique géométrique.
// @{

const TOrbit ORBIT_VERTEX = ORBIT_123 ; //@< Orbite sommet.
const TOrbit ORBIT_EDGE   = ORBIT_023 ; //@< Orbite arête.
const TOrbit ORBIT_FACE   = ORBIT_013 ; //@< Orbite face.
const TOrbit ORBIT_VOLUME = ORBIT_012 ; //@< Orbite volume.
const TOrbit ORBIT_CC     = ORBIT_0123; //@< Orbite composante connexe.

// @}

//****************************************************************************
// @name Ensembles d'orbites particuliers.
// @{

const TOrbit ORBIT_INF[4] =
{
  ORBIT_SELF, ORBIT_0, ORBIT_01, ORBIT_012
};

const TOrbit ORBIT_CELL[5] =
{
  ORBIT_VERTEX, ORBIT_EDGE, ORBIT_FACE, ORBIT_VOLUME, ORBIT_CC
};

const TOrbit ORBIT_BORDER [4] =
{
  ORBIT_BORDER_0, ORBIT_BORDER_1, ORBIT_BORDER_2, ORBIT_BORDER_3
};

const TOrbit ORBIT_I_IM1[4] =
{
  ORBIT_0, ORBIT_01, ORBIT_12, ORBIT_23
};

const TOrbit ORBIT_I_IP1[4] =
{
  ORBIT_01, ORBIT_12, ORBIT_23, ORBIT_3
};

const TOrbit ORBIT_INVO[4] =
{
  ORBIT_23, ORBIT_3, ORBIT_0, ORBIT_01
};

const TOrbit ORBIT_SEWS[4] =
{
  ORBIT_023, ORBIT_13, ORBIT_02, ORBIT_013
};

const TOrbit ORBIT_DIM[4] =
{
  ORBIT_0, ORBIT_1, ORBIT_2, ORBIT_3
};

// @}

//******************************************************************************
// @name Opérations (interne au fonctionnement des parcours).

// @{

typedef int8_t TOperationState;

enum
{
  OP_NONE = -1,

  OP_ALPHA0,
  OP_ALPHA1,
  OP_ALPHA2,
  OP_ALPHA3,
  OP_ALPHAI,
  OP_ALPHAJ,
  OP_ALPHAK,

  OP_JUMP,
  OP_TURN_AROUND,
  OP_END,

  // Lorsqu'on parcourt une liste de brins (static et multidynamic coverages).
  OP_UNKNOWN
};

// @}

//****************************************************************************
// @{

typedef std::bitset<16> TMask16;

//****************************************************************************


const TMask16 MASK_FALSE((unsigned int) 0x0000); // 0000 0000 0000 0000
const TMask16 MASK_TRUE((unsigned int) 0xFFFF); // 1111 1111 1111 1111

const TMask16 MASK0((unsigned int) 0xAAAA); // 1010 1010 1010 1010
const TMask16 MASK1((unsigned int) 0xCCCC); // 1100 1100 1100 1100
const TMask16 MASK2((unsigned int) 0xF0F0); // 1111 0000 1111 0000
const TMask16 MASK3((unsigned int) 0xFF00); // 1111 1111 0000 0000

const TMask16 MASK0M2(MASK0 & ~MASK2);
const TMask16 MASK0M3(MASK0 & ~MASK3);
const TMask16 MASK1M3(MASK1 & ~MASK3);
const TMask16 MASK2M0(MASK2 & ~MASK0);
const TMask16 MASK3M0(MASK3 & ~MASK0);
const TMask16 MASK3M1(MASK3 & ~MASK1);

// @}

//******************************************************************************

typedef int8_t TBurstMethod;

enum
{
  FIRST_BURST_METHOD = 0,
  
  BURST_METHOD_SCALE = FIRST_BURST_METHOD,
  BURST_METHOD_SHIFT,

  LAST_BURST_METHOD
};


//******************************************************************************
#endif // KERNEL_TYPES_HH
//******************************************************************************