summaryrefslogtreecommitdiffstats
path: root/raslib/point.hh
blob: 6f6e634f536b348e6537bcc44f50c927b25271be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
* This file is part of rasdaman community.
*
* Rasdaman community 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.
*
* Rasdaman community 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 rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
/
/**
 * INCLUDE: point.hh
 *
 * MODULE:  raslib
 * CLASS:   r_Point
 *
 * COMMENTS:
 *
*/

#ifndef _D_POINT_
#define _D_POINT_

#ifdef __VISUALC__
// disable warning for exception specification
#pragma warning( disable : 4290 )
#endif

class r_Error;
class r_Einit_overflow;
class r_Eindex_violation;
class r_Edim_mismatch;

#include "raslib/mddtypes.hh"
#include "raslib/error.hh"

#include <iostream>

//@ManMemo: Module: {\bf raslib}

/*@Doc:

 Class \Ref{r_Point} represents an n-dimensional point vector.
 
*/
 
class r_Point
{
  public: 
    /// constructor getting dimensionality for stream initializing
    r_Point( r_Dimension );
    
    /// stream-input operator for stream initializing
    r_Point& operator<<( r_Range ) throw( r_Einit_overflow );

    /// constructor taking string representation (e.g. [ 1, 2, 3])
    r_Point( char* ) throw( r_Error );

    //@Man: 'easy-to-use' constructors
    //@{
    ///
    r_Point( r_Range, r_Range );
    ///
    r_Point( r_Range, r_Range, r_Range );
    ///
    r_Point( r_Range, r_Range, r_Range, r_Range );
    ///
    r_Point( r_Range, r_Range, r_Range, r_Range, r_Range );
    ///
    //@}

    /// default constructor 
    r_Point();              
    
    /// copy constructor
    r_Point( const r_Point& );            

    /// destructor: cleanup dynamic memory
    ~r_Point();                             

    /// subscriptor for read access
    r_Range  operator[]( r_Dimension ) const throw( r_Eindex_violation );     
    /// subscriptor for write access
    r_Range& operator[]( r_Dimension ) throw( r_Eindex_violation );    
	     
    /// assignment: cleanup + copy
    const r_Point& operator= ( const r_Point& );
    
    /// compares this point with the given point.
    inline const int compare_with( const  r_Point& p ) const; 
    /**
      Returns 0 if this == p, -1 if this < p, 1 if this > p (considering 
      the coordinates in decreasing order of magnitude). 
    */

    /// equal operator 
    bool operator==( const r_Point& ) const;
    
    /**
      Two points are equal if they have the same number of dimensions and 
      the same values.
    */
    
    /// non equal operator - negation of equal operator
    bool operator!=( const r_Point& ) const;

    /// vector addition
    r_Point operator+( const r_Point& ) const           
             throw( r_Edim_mismatch );    
    
    /// vector subtraction
    r_Point operator-( const r_Point& ) const           
             throw( r_Edim_mismatch );    
    
    /// vector multiplication
    r_Point operator*( const r_Point& ) const           
             throw( r_Edim_mismatch );    
    
    /// get dimensionality       
    inline r_Dimension dimension() const;   

    /// writes the state of the object to the specified stream
    void print_status( std::ostream& s = std::cout ) const;
    
    /// gives back the string representation
    char* get_string_representation() const;
    /**
      The string representation delivered by this method is allocated using {\tt malloc()} and
      has to be free unsing {\tt free()} in the end. It can be used to construct a {\tt r_Point}
      again with a special constructor provided. The string representation is build using 
      {\tt print_status()}.
    */

  private:
    /// array holding the point coordinates
    r_Range*    points;
    /// dimensionality of the point
    r_Dimension dimensionality;
    /// number of components initialized already
    r_Dimension streamInitCnt; 
};



//@ManMemo: Module: {\bf raslib}
/**
  Output stream operator for objects of type {\tt const} \Ref{r_Point}.
*/  
extern std::ostream& operator<<( std::ostream& s, const r_Point& d );

#include "raslib/point.icc"

#endif