cvrTypes.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */



/**
 * \file   cvrTypes.h
 *         This file contains the definitions of the basic types used in the
 *         CVR-Lib.
 *
 *         Some types are redefined to compensate the lack of specification in
 *         the C++ Standard about the byte length of the standard types int,
 *         char, float, etc.  Here an cvr::uint32 uses always four bytes,
 *         cvr::uint16 uses two bytes and so on.
 *
 *         The defined basic types are:
 *         - cvr::ubyte  (1 byte unsigned)
 *         - cvr::byte   (1 byte signed)
 *         - cvr::uint16 (2 byte unsigned)
 *         - cvr::int16  (2 byte signed)
 *         - cvr::uint32 (4 byte unsigned)
 *         - cvr::int32  (4 byte signed)
 *         - cvr::uint64 (8 byte unsigned)
 *         - cvr::int64  (8 byte signed)
 *         - cvr::sreal  (4 byte floating point)
 *         - cvr::dreal  (8 byte floating point)
 *
 * \author  Pablo Alvarado
 * \date    31.03.1999
 *
 * $Id: cvrTypes.h,v 1.7 2007/04/18 21:13:40 alvarado Exp $
 */

#ifndef _CVR_TYPES_H
#define _CVR_TYPES_H

#include "cvrConfig.h"

namespace cvr {
  /**
   * 8-bit unsigned type (0..255)
   *
   * @ingroup gTypes
   */
  typedef unsigned _CVR_BYTE ubyte;

  /**
   * 8-bit signed type (-128..127)
   *
   * @ingroup gTypes
   */
  typedef signed _CVR_BYTE byte;

  /**
   * 16-bit unsigned type (0..65535)
   *
   * @ingroup gTypes
   */
  typedef unsigned _CVR_WORD16 uint16;

  /**
   * 16-bit signed type (-32768..32767)
   *
   * @ingroup gTypes
   */
  typedef signed _CVR_WORD16 int16;

  /**
   * 32-bit unsigned type (0..(2^32)-1)
   *
   * @ingroup gTypes
   */
  typedef unsigned _CVR_WORD32 uint32;

  /**
   * 32-bit signed type (-(2^31)..(2^31-1))
   *
   * @ingroup gTypes
   */
  typedef signed _CVR_WORD32 int32;

  /**
   * 64-bit unsigned type (0..(2^64)-1)
   *
   * @ingroup gTypes
   */
  __extension__ typedef unsigned _CVR_WORD64 uint64;

  /**
   * 64-bit signed type (-(2^63)..(2^63-1))
   *
   * @ingroup gTypes
   */
  __extension__ typedef signed _CVR_WORD64 int64;

  /**
   * 32-bit floating point type
   *
   * @ingroup gTypes
   */
  typedef float sreal;

  /**
   * 64-bit floating point type
   *
   * @ingroup gTypes
   */
  typedef double dreal;

  /**
   * Minimal int32 value achievable using only 24bits
   */
  const int32 MinInt24 = -0x00800000;

  /**
   * Maximal int32 value achievable using only 24bits
   */
  const int32 MaxInt24 = +0x007fffff;

}

#endif