yat/omic/DnaComplementer.h

Code
Comments
Other
Rev Date Author Line
3475 08 Mar 16 peter 1 #ifndef _theplu_yat_omic_dna_complementer
3475 08 Mar 16 peter 2 #define _theplu_yat_omic_dna_complementer
3475 08 Mar 16 peter 3
4346 24 Apr 23 peter 4 /*
4346 24 Apr 23 peter 5   Copyright (C) 2016, 2017, 2018, 2023 Peter Johansson
3475 08 Mar 16 peter 6
4346 24 Apr 23 peter 7   This file is part of the yat library, https://dev.thep.lu.se/yat
4346 24 Apr 23 peter 8
4346 24 Apr 23 peter 9   The yat library is free software; you can redistribute it and/or
4346 24 Apr 23 peter 10   modify it under the terms of the GNU General Public License as
4346 24 Apr 23 peter 11   published by the Free Software Foundation; either version 3 of the
4346 24 Apr 23 peter 12   License, or (at your option) any later version.
4346 24 Apr 23 peter 13
4346 24 Apr 23 peter 14   The yat library is distributed in the hope that it will be useful,
4346 24 Apr 23 peter 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4346 24 Apr 23 peter 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4346 24 Apr 23 peter 17   General Public License for more details.
4346 24 Apr 23 peter 18
4346 24 Apr 23 peter 19   You should have received a copy of the GNU General Public License
4346 24 Apr 23 peter 20   along with yat. If not, see <https://www.gnu.org/licenses/>.
4346 24 Apr 23 peter 21 */
4346 24 Apr 23 peter 22
3475 08 Mar 16 peter 23 namespace theplu {
3475 08 Mar 16 peter 24 namespace yat {
3475 08 Mar 16 peter 25 namespace omic {
3475 08 Mar 16 peter 26
3475 08 Mar 16 peter 27   /**
3475 08 Mar 16 peter 28     \brief Functor that calculates genomic complement
3475 08 Mar 16 peter 29
3475 08 Mar 16 peter 30     \since New in yat 0.14
3475 08 Mar 16 peter 31    */
3475 08 Mar 16 peter 32   struct DnaComplementer
3475 08 Mar 16 peter 33   {
3475 08 Mar 16 peter 34     /**
3475 08 Mar 16 peter 35        Calculates the compement base of x, i.e., 'A' returns 'T'
3703 15 Oct 17 peter 36        etc. Function handles lowercase letters, so a passed 'a'
3475 08 Mar 16 peter 37        returns 't'.
3475 08 Mar 16 peter 38
3475 08 Mar 16 peter 39        \return complement base of x
3475 08 Mar 16 peter 40
3475 08 Mar 16 peter 41        \see DNA::complement()
3475 08 Mar 16 peter 42      */
3475 08 Mar 16 peter 43     char operator()(char x) const;
3475 08 Mar 16 peter 44   };
3475 08 Mar 16 peter 45
3475 08 Mar 16 peter 46 }}}
3475 08 Mar 16 peter 47 #endif

Generated on Sat Oct 14 02:22:48 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)