/home/archives/knight-path/branch.1/branch.0/delta5682.018/knight-path/position.h

Go to the documentation of this file.

//
// knight-path - shortest knight path between two squares
// Copyright (C) 2011 Peter Miller
//
// This program 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 3 of the License, or (at
// your option) any later version.
//
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef KNIGHT_PATH_POSITION_H
#define KNIGHT_PATH_POSITION_H

#include <iostream>
#include <vector>

class position
{
public:
    typedef std::vector<position> list_t;

    ~position();

    position();

    position(char rank, char file);

    position(const position &rhs);

    position &operator=(const position &rhs);

    list_t knight_moves(void) const;

    static position read(std::istream &is);

    void write(std::ostream &os) const;

    bool operator==(const position &rhs) const;

    bool operator!=(const position &rhs) const;

    void plot(char board[8][8], char c) const;

    int distance(const position &elsewhere) const;

private:
    position(int x, int y);

    unsigned p;

    bool valid(void) const;

    char get_rank(void) const;

    char get_file(void) const;

public:
    // reluctantly made public, becaiuse solver_maze needs access

    int get_x(void) const;

    int get_y(void) const;
};

inline std::istream &
operator>>(std::istream &is, position &p)
{
    p = position::read(is);
    return is;
}

inline std::ostream &
operator<<(std::ostream &os, const position &p)
{
    p.write(os);
    return os;
}

#endif // KNIGHT_PATH_POSITION_H