LoBits.H

Go to the documentation of this file.

/**
   \file  Robots/LoBot/util/LoBits.H
   \brief Bit fiddling functions.
*/

// //////////////////////////////////////////////////////////////////// //
// The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
// by the University of Southern California (USC) and the iLab at USC.  //
// See http://iLab.usc.edu for information about this project.          //
// //////////////////////////////////////////////////////////////////// //
// Major portions of the iLab Neuromorphic Vision Toolkit are protected //
// under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
// in Visual Environments, and Applications'' by Christof Koch and      //
// Laurent Itti, California Institute of Technology, 2001 (patent       //
// pending; application number 09/912,225 filed July 23, 2001; see      //
// http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
// //////////////////////////////////////////////////////////////////// //
// This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit 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.     //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit 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 the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
// to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
// Boston, MA 02111-1307 USA.                                           //
// //////////////////////////////////////////////////////////////////// //
//
// Primary maintainer for this file: mviswana usc edu
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Robots/LoBot/util/LoBits.H $
// $Id: LoBits.H 13037 2010-03-23 01:00:53Z mviswana $
//

#ifndef LOBOT_BIT_FIDDLING_UTILITIES_DOT_H
#define LOBOT_BIT_FIDDLING_UTILITIES_DOT_H

//----------------------------- NAMESPACE -------------------------------

namespace lobot {

//---------------------- BIT FIDDLING FUNCTIONS -------------------------

/// Stuff two 16-bit ints into a long
inline unsigned long make_long(int hi, int lo)
{
   return ((hi & 0xFFFF) << 16) | (lo & 0xFFFF) ;
}

/// Extract the lower 16 bits of a long
inline int loword(unsigned long L)
{
   return static_cast<int>(L & 0xFFFF) ;
}

/// Extract the higher 16 bits of a long
inline int hiword(unsigned long L)
{
   return loword(L >> 16) ;
}

/// Stuff two signed 8-bit ints into a single 16-bit int
inline int make_word(int hi, int lo)
{
   return (hi << 8) | (lo & 0xFF) ;
}

/// Stuff two unsigned 8-bit ints into a single 16-bit int
inline int make_uword(int hi, int lo)
{
   return ((hi << 8) & 0xFF00) | (lo & 0xFF) ;
}

/// Extract the low byte of a 16-bit word
inline char lobyte(short int word)
{
   return static_cast<char>(word & 0xFF) ;
}

/// Extract the high byte of a 16-bit word
inline char hibyte(short int word)
{
   return lobyte(word >> 8) ;
}

/// Set a bit in a register to the specified value. The bit to be set or
/// cleared is identified by the given mask.
int set_bit(int reg, int mask, bool val) ;

/// Force the supplied number to be an odd number
inline int force_odd(int n)
{
   return n | 1 ;
}

/// Force the supplied number to be an even number
inline int force_even(int n)
{
   return n & (~1) ;
}

//-----------------------------------------------------------------------

} // end of namespace encapsulating this file's definitions

#endif

/* So things look consistent in everyone's emacs... */
/* Local Variables: */
/* indent-tabs-mode: nil */
/* End: */