vctStoreBackBinaryOperations.h

Go to the documentation of this file.

/* -*- 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: */

/*

  Author(s):  Ofri Sadowsky, Anton Deguet
  Created on: 2003-08-18

  (C) Copyright 2003-2013 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 ---
*/

#pragma once
#ifndef _vctStoreBackBinaryOperations_h
#define _vctStoreBackBinaryOperations_h

template<class _inputOutputType, class _input2Type = _inputOutputType>
class vctStoreBackBinaryOperations {
    public:
    typedef _inputOutputType InputOutputType;
    typedef _input2Type Input2Type;

    class Addition {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & input2) {
            input1 += input2;
            return input1;
        }
    };


    class Subtraction {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & input2) {
            input1 -= input2;
            return input1;
        }
    };


    class Multiplication {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & input2) {
            input1 *= input2;
            return input1;
        }
    };


    class Division {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & input2) {
            input1 /= input2;
            return input1;
        }
    };


    class FirstOperand {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & CMN_UNUSED(input2)) {
            return (input1);
        }
    };


    class SecondOperand {
    public:
        static inline InputOutputType & Operate(InputOutputType & input1, const Input2Type & input2) {
            input1 = input2;
            return input1;
        }
    };


    class Maximum {
    public:
        static inline const InputOutputType & Operate(InputOutputType & input1,
                                                      const InputOutputType & input2) {
            input1 = (input1 > input2) ? input1 : input2;
            return input1;
        }
    };



    class ClipIn {
    public:
        static inline const InputOutputType & Operate(InputOutputType & input,
                                                      const InputOutputType & bound) {
            if (input > bound) {
                input = bound;
            } else if (input < -bound) {
                input = -bound;
            }
            return input;
        }
    };


    class Minimum {
    public:
        static inline const InputOutputType & Operate(InputOutputType & input1,
                                                      const InputOutputType & input2) {
            input1 = (input1 < input2) ? input1 : input2;
            return input1;
        }
    };

    class Swap {
    public:
        static inline void Operate(InputOutputType & input1,
                                   InputOutputType & input2) {
            const InputOutputType tmp(input1);
            input1 = input2;
            input2 = tmp;
        }
    };

};


#endif  // _vctStoreBackBinaryOperations_h