xor.hh

// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena 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, version 2 of the License.
//
// Olena 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 Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_LOGICAL_XOR_HH
# define MLN_LOGICAL_XOR_HH


# include <mln/logical/includes.hh>
# include <mln/fun/vv2v/lxor.hh>


namespace mln
{

  namespace logical
  {

    template <typename L, typename R>
    mln_ch_fun_vv2v(lxor, L, R)
    xor_(const Image<L>& lhs, const Image<R>& rhs);


    template <typename L, typename R>
    void xor_inplace(Image<L>& lhs, const Image<R>& rhs);


# ifndef MLN_INCLUDE_ONLY

    template <typename L, typename R>
    inline
    mln_ch_fun_vv2v(lxor, L, R)
    xor_(const Image<L>& lhs, const Image<R>& rhs)
    {
      trace::entering("logical::xor_");

      internal::tests(lhs, rhs);

      mln_fun_vv2v(lxor, L, R) f;
      mln_ch_fun_vv2v(lxor, L, R) output = data::transform(lhs, rhs, f);

      trace::exiting("logical::xor_");
      return output;
    }

    template <typename L, typename R>
    inline
    void xor_inplace(Image<L>& lhs, const Image<R>& rhs)
    {
      trace::entering("logical::xor_inplace");

      mlc_converts_to(mln_fun_vv2v_result(lxor, L, R),
                      mln_value(L))::check();

      internal::tests(lhs, rhs);

      mln_fun_vv2v(lxor, L, R) f;
      data::transform_inplace(lhs, rhs, f);

      trace::exiting("logical::xor_inplace");
    }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::logical

} // end of namespace mln


#endif // ! MLN_LOGICAL_XOR_HH