/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  $Id: vctStoreBackUnaryOperations.h,v 1.13 2007/04/26 19:33:58 anton Exp $
  
  Author(s):	Ofri Sadowsky, Anton Deguet
  Created on:	2003-08-18

  (C) Copyright 2003-2007 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


/*! 
  \file 
  \brief Declaration of vctStoreBackUnaryOperations.
 */


#ifndef _vctStoreBackUnaryOperations_h
#define _vctStoreBackUnaryOperations_h


/*!  \brief Define store back unary operations on an object as
  classes.

  Class vctStoreBackUnaryOperations is an envelope that wraps unary
  store back operations on an object as classes.
  vctStoreBackUnaryOperations defines internal classes such as
  MakeAbs, MakeNegation, etc., and each of the internal classes has
  one static function named Operate(), which wraps the corresponding
  operation.  The signature of a typical Operate() is

  <PRE> static inline InputOutputType Operate(const InputOutputType & inputOutput)
  </PRE>

  Where InputOutputType is the type of the result and the operand.

  By abstracting very simple operations as inline functions, we can
  plug the vctUnaryOperations internal classes into templated vector
  operation engines.  See an example of such engine in
  vctFixedSizeVectorRecursiveEngines.h , and an example of plugging an
  operation into the engine in vctFixedSizeVectorOperations.h .

  \param inputOutputElementType the type of the operand

  \sa MakeAbs MakeNegation
*/
template<class _inputOutputElementType>
class vctStoreBackUnaryOperations
{
    public:
    typedef _inputOutputElementType InputOutputElementType;

    /*!
      \brief Returns the absolute value of the input as an OutputType object.
      \sa vctStoreBackUnaryOperations
     */
    class MakeAbs {
    public:
        /*!
          Execute the operation.
          \param inputOutput Input output.
        */
        static inline InputOutputElementType Operate(InputOutputElementType & inputOutput) {
            return (inputOutput = (inputOutput > InputOutputElementType(0))
                    ?
                    InputOutputElementType(inputOutput)
                    :
                    InputOutputElementType(-inputOutput));
        }
    };
    
    /*!
      \brief Returns the negation of the input as an OutputType object.
      \sa vctStoreBackUnaryOperations
     */
    class MakeNegation {
    public:
        /*!
          Execute the operation.
          \param inputOutput Input output.
        */
        static inline InputOutputElementType Operate(InputOutputElementType & inputOutput) {
            return (inputOutput = InputOutputElementType(-inputOutput));
        }
    };

    /*! \brief Returns the floor of the input, that is, the largest integer less-than
      or equal to the input, as an OutputType object.
      \sa vctUnaryOperations
     */
    class MakeFloor {
    public:
        static inline InputOutputElementType Operate(InputOutputElementType & inputOutput) {
            return (inputOutput = InputOutputElementType( floor((double)inputOutput) ));
        }
    };

    /*! \brief Returns the ceiling of the input, that is, the smallest integer greater-than
      or equal to the input, as an OutputType object.
      \sa vctUnaryOperations
     */
    class MakeCeil {
    public:
        static inline InputOutputElementType Operate(InputOutputElementType & inputOutput) {
            return (inputOutput = InputOutputElementType( ceil((double)inputOutput) ));
        }
    };


};


#endif  // _vctStoreBackUnaryOperations_h


// ****************************************************************************
//                              Change History
// ****************************************************************************
//
// $Log: vctStoreBackUnaryOperations.h,v $
// Revision 1.13  2007/04/26 19:33:58  anton
// All files in libraries: Applied new license text, separate copyright and
// updated dates, added standard header where missing.
//
// Revision 1.12  2006/11/20 20:33:20  anton
// Licensing: Applied new license to cisstCommon, cisstVector, cisstNumerical,
// cisstInteractive, cisstImage and cisstOSAbstraction.
//
// Revision 1.11  2005/12/29 23:39:26  anton
// cisstVector: Cast values to double before calling floor or ceil (for .net 2003)
//
// Revision 1.10  2005/12/12 23:49:21  ofri
// vct[StoreBack]UnaryOperations : Added operations for [Make]Floor and
// [Make]Ceil to be used in the Floor and Ceil operations on vectors and matrices
//
// Revision 1.9  2005/09/26 15:41:47  anton
// cisst: Added modelines for emacs and vi.
//
// Revision 1.8  2005/05/19 19:29:01  anton
// cisst libs: Added the license to cisstCommon and cisstVector
//
// Revision 1.7  2004/10/25 13:52:05  anton
// Doxygen documentation:  Cleanup all the useless \ingroup.
//
// Revision 1.6  2004/08/13 17:47:40  anton
// cisstVector: Massive renaming to replace the word "sequence" by "vector"
// (see ticket #50) as well as another more systematic naming for the engines.
// The changes for the API are as follow:
// *: vctFixedLengthSequenceBase -> vctFixedSizeVectorBase (and Const)
// *: vctFixedLengthSequenceRef -> vctFixedSizeVectorRef (and Const)
// *: vctDynamicSequenceBase -> vctDynamicVectorBase (and Const)
// *: vctDynamicSequenceRef -> vctDynamicVectorRef (and Const)
// *: vctDynamicSequenceRefOwner -> vctDynamicVectorRefOwner
// *: vctFixedStrideSequenceIterator -> vctFixedStrideVectorIterator (and Const)
// *: vctVarStrideSequenceIterator -> vctVarStrideVectorIterator (and Const)
// *: vctSequenceRecursiveEngines -> vctFixedSizeVectorRecursiveEngines
// *: vctSequenceLoopEngines -> vctDynamicVectorLoopEngines
// *: vctMatrixLoopEngines -> vctFixedSizeMatrixLoopEngines
// *: vctDynamicMatrixEngines -> vctDynamicMatrixLoopEngines
// Also updated and corrected the documentation (latex, doxygen, figures) as
// well as the tests and examples.
//
// Revision 1.5  2004/07/02 16:16:45  anton
// Massive renaming in cisstVector for the addition of dynamic size vectors
// and matrices.  The dynamic vectors are far from ready.
//
// Revision 1.4  2004/04/06 15:23:15  anton
// Doxygen clean-up
//
// Revision 1.3  2003/10/03 19:10:21  anton
// cleaned doxygen documentation
//
// Revision 1.2  2003/09/17 17:41:56  anton
// added an _ to prefix all the template arguments
//
// Revision 1.1  2003/09/09 18:51:46  anton
// creation
//
//
// ****************************************************************************