cvd/image_ref.h

/*
    This file is part of the CVD Library.

    Copyright (C) 2005 The Authors

    This library 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 2.1 of the License, or (at your option) any later version.

    This library 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 library; if not, write to the Free Software
    Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
//-*- c++ -*-
//                                                                      //
//  CVD::image.h                                                        //
//                                                                      //
//  Definitions for of template classes CVD::ImageRef and CVD::Image    //
//                                                                      //
//  derived from IPRS_* developed by Tom Drummond                       //
//                                                                      //

#ifndef __CVD_IMAGE_REF_H__
#define __CVD_IMAGE_REF_H__

#include <iostream>
#include <cctype>
#include <cvd/exceptions.h>

namespace CVD {


// CVD::ImageRef                    //
class ImageRef
{
public:

    //Construction
    inline ImageRef();
    inline ImageRef(int xp, int yp);
    inline ImageRef(std::istream& is);

    //Iteration

    inline bool next(const ImageRef& max);
    inline bool prev(const ImageRef& max);
    inline bool next(const ImageRef& min, const ImageRef& max);
    inline bool prev(const ImageRef& min, const ImageRef& max);

    inline void home();
    inline void end(const ImageRef& size);


    //Operators

    inline ImageRef&    operator=(const ImageRef& ref);
    inline bool         operator==(const ImageRef& ref) const;
    inline bool         operator!=(const ImageRef& ref) const;
  inline ImageRef  operator-() const;
  inline ImageRef&  operator*=(const double scale);
    inline ImageRef&    operator/=(const double scale);
    inline ImageRef&    operator+=(const ImageRef rhs);
    inline ImageRef&    operator-=(const ImageRef rhs);
    inline ImageRef     operator*(const double scale) const;
    inline ImageRef     operator/(const double scale) const;
    inline ImageRef     operator+(const ImageRef rhs) const;
    inline ImageRef     operator-(const ImageRef rhs) const;
    inline ImageRef&    operator<<=(int i);
    inline ImageRef&    operator>>=(int i);
    inline ImageRef     operator>>(int i) const;
    inline ImageRef     operator<<(int i) const;
  inline bool operator<(const ImageRef & other) const;
  inline bool operator>(const ImageRef & other) const;

    inline unsigned int     mag_squared() const;

    inline int area() const;

    inline ImageRef dot_times(const ImageRef &ref) const;

    inline int& operator[](int i);

    inline int operator[](int i) const;

    //Why do these exist?
    inline ImageRef shiftl(int i) const;
    inline ImageRef shiftr(int i) const;

    // and now the data members (which are public!)
    int x; 
    int y; 

};

inline ImageRef operator*(const int scale, const ImageRef&  ref);

namespace Exceptions
{
  struct BadSubscript: public CVD::Exceptions::All {BadSubscript(){};};
}


#include <cvd/internal/image_ref_implementation.hh>

// Streams stuff for ImageRef class //

inline std::ostream& operator<<(std::ostream& os, const ImageRef& ref)
{
    return os << "[" << ref.x << " " << ref.y << "]";
}

inline std::istream& operator>>(std::istream& is, ImageRef& ref)
{
    //Full parsing for ImageRefs, to allow it to accept the
    //output produced above, as well as the older (x,y) format
    is >> std::ws;

    unsigned char c = is.get();

    if(is.eof())
        return is;

    if(c == '(' )
    {
        is >> std::ws >> ref.x >> std::ws;

        if(is.get() != ',')
            goto bad;

        is >> std::ws >> ref.y >> std::ws;

        if(is.get() != ')')
            goto bad;
    }
    else if(c == '[' )
    {
        is >> std::ws >> ref.x >> std::ws >> ref.y >> std::ws;
        if(is.get() != ']')
            goto bad;
    }
    else if(isdigit(c))
    {
        is.unget();
        is >> ref.x >> ref.y;
    }
    else
        goto bad;

    return is;

    bad:
    is.setstate(std::ios_base::badbit);

    return is;
}

const ImageRef ImageRef_zero(0, 0);


} //namespace CVD


#endif