1 /*
 2  *   Copyright (c) 2004, Alexander Stippler
 3  *
 4  *   All rights reserved.
 5  *
 6  *   Redistribution and use in source and binary forms, with or without
 7  *   modification, are permitted provided that the following conditions
 8  *   are met:
 9  *
10  *   1) Redistributions of source code must retain the above copyright
11  *      notice, this list of conditions and the following disclaimer.
12  *   2) Redistributions in binary form must reproduce the above copyright
13  *      notice, this list of conditions and the following disclaimer in
14  *      the documentation and/or other materials provided with the
15  *      distribution.
16  *   3) Neither the name of the FLENS development group nor the names of
17  *      its contributors may be used to endorse or promote products derived
18  *      from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef FLENS_AUX_RANGE_H
34 #define FLENS_AUX_RANGE_H 1
35 
36 #include <iostream>
37 
38 namespace flens {
39 
40 template <typename IndexType = long>
41 class Range
42 {
43     public:
44         Range(IndexType firstIndex, IndexType lastIndex);
45 
46         Range(IndexType firstIndex, IndexType stride, IndexType lastIndex);
47 
48         IndexType
49         firstIndex() const;
50 
51         IndexType
52         stride() const;
53 
54         IndexType
55         lastIndex() const;
56 
57         IndexType
58         numTicks() const;
59 
60         IndexType
61         length() const;
62 
63     private:
64         IndexType _firstIndex, _stride, _lastIndex;
65 };
66 
67 template <typename IndexType>
68     std::ostream &
69     operator<<(std::ostream &out, const Range<IndexType> &range);
70 
71 template <typename IndexType>
72     bool
73     operator==(const Range<IndexType> &lhs, const Range<IndexType> &rhs);
74 
75 // namespace flens
76 
77 #endif // FLENS_AUX_RANGE_H