Zivid C++ API  2.3.1+1a22cbf1-1
Defining the Future of 3D Machine Vision
Range.h
Go to the documentation of this file.
1 
2 /*******************************************************************************
3  * This file is part of the Zivid 3D Camera API
4  *
5  * Copyright 2015-2022 (C) Zivid AS
6  * All rights reserved.
7  *
8  * Zivid Software License, v1.0
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
21  * to endorse or promote products derived from this software without specific
22  * prior written permission.
23  *
24  * 4. This software, with or without modification, must not be used with any
25  * other 3D camera than from Zivid AS.
26  *
27  * 5. Any software provided in binary form under this license must not be
28  * reverse engineered, decompiled, modified and/or disassembled.
29  *
30  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
34  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 
47 #include <sstream>
48 
49 namespace Zivid
50 {
56  template<typename T>
57  class Range
58  {
59  public:
61  constexpr Range(T min, T max)
62  : m_min{ std::move(min) }
63  , m_max{ std::move(max) }
64  {}
65 
67  constexpr const T &min() const
68  {
69  return m_min;
70  }
71 
73  constexpr const T &max() const
74  {
75  return m_max;
76  }
77 
83  constexpr bool isInRange(const T &value) const
84  {
85  return value >= m_min && value <= m_max;
86  }
87 
89  bool operator==(const Range<T> &other) const
90  {
91  return m_min == other.m_min && m_max == other.m_max;
92  }
93 
95  bool operator!=(const Range<T> &other) const
96  {
97  return !operator==(other);
98  }
99 
101  std::string toString() const
102  {
103  std::stringstream stream;
104  stream << "{ " << m_min << ", " << m_max << " }";
105  return stream.str();
106  }
107 
108  private:
109  T m_min;
110  T m_max;
111  };
112 
114  template<typename T>
115  std::ostream &operator<<(std::ostream &os, const Range<T> &range)
116  {
117  return os << range.toString();
118  }
119 } // namespace Zivid
Class describing a range of values for a given type T
Definition: Range.h:58
bool operator!=(const Range< T > &other) const
Comparison operator
Definition: Range.h:95
constexpr Range(T min, T max)
Constructor
Definition: Range.h:61
constexpr bool isInRange(const T &value) const
Check if the value is in range
Definition: Range.h:83
bool operator==(const Range< T > &other) const
Comparison operator
Definition: Range.h:89
constexpr const T & max() const
Get the maximum value of the range
Definition: Range.h:73
std::string toString() const
Get the range as string
Definition: Range.h:101
constexpr const T & min() const
Get the minimum value of the range
Definition: Range.h:67
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:55
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream
Definition: Array2D.h:170