SeqAn3
concept.hpp
Go to the documentation of this file.
1 // ============================================================================
2 // SeqAn - The Library for Sequence Analysis
3 // ============================================================================
4 //
5 // Copyright (c) 2006-2018, Knut Reinert & Freie Universitaet Berlin
6 // Copyright (c) 2016-2018, Knut Reinert & MPI Molekulare Genetik
7 // All rights reserved.
8 //
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are met:
11 //
12 // * Redistributions of source code must retain the above copyright
13 // notice, this list of conditions and the following disclaimer.
14 // * Redistributions in binary form must reproduce the above copyright
15 // notice, this list of conditions and the following disclaimer in the
16 // documentation and/or other materials provided with the distribution.
17 // * Neither the name of Knut Reinert or the FU Berlin nor the names of
18 // its contributors may be used to endorse or promote products derived
19 // from this software without specific prior written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 // ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
25 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 // OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
31 // DAMAGE.
32 //
33 // ============================================================================
34 
40 #pragma once
41 
42 #include <type_traits>
43 
45 #include <seqan3/std/concepts>
46 
47 namespace seqan3
48 {
49 
50 inline namespace simd
51 {
52 
62 template <typename simd_t>
64 concept simd_concept = requires (simd_t a, simd_t b)
65 {
69 
70  // require that static member variables are defined
73 
74  // assume array access that returns a scalar_type type
75  { a[0] } -> typename simd_traits<simd_t>::scalar_type;
76 
77  // require comparison operators
84 
85  // require arithmetic operators
87  requires std::Same<decltype(a - b), simd_t>;
89  requires std::Same<decltype(a / b), simd_t>;
91  requires std::Same<decltype(a -= b), simd_t &>;
93  requires std::Same<decltype(a /= b), simd_t &>;
94 };
96 
97 } // inline namespace simd
98 
99 } // namespace seqan3
Contains seqan3::simd::simd_traits.
IMPLEMENTATION_DEFINED mask_type
The type returned by comparison operators (is not defined if simd_t does not satisfy seqan3::simd::si...
Definition: simd_traits.hpp:84
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:58
The concept Integral is satisfied if and only if T is an integral type.
IMPLEMENTATION_DEFINED scalar_type
The underlying type of a simd vector (is not defined if simd_t does not satisfy seqan3::simd::simd_co...
Definition: simd_traits.hpp:71
The Concepts library.
The concept std::Same<T, U> is satisfied if and only if T and U denote the same type.
Provides C++20 additions to the type_traits header.
IMPLEMENTATION_DEFINED swizzle_type
The type used to define how to swizzle a simd vector (is not defined if simd_t does not satisfy seqan...
Definition: simd_traits.hpp:88