io.hpp

Go to the documentation of this file.

#ifndef VIENNACL_SCHEDULER_IO_HPP
#define VIENNACL_SCHEDULER_IO_HPP

/* =========================================================================
   Copyright (c) 2010-2016, Institute for Microelectronics,
                            Institute for Analysis and Scientific Computing,
                            TU Wien.
   Portions of this software are copyright by UChicago Argonne, LLC.

                            -----------------
                  ViennaCL - The Vienna Computing Library
                            -----------------

   Project Head:    Karl Rupp                   rupp@iue.tuwien.ac.at

   (A list of authors and contributors can be found in the manual)

   License:         MIT (X11), see file LICENSE in the base directory
============================================================================= */


#include <iostream>
#include <sstream>

#include "viennacl/forwards.h"
#include "viennacl/scheduler/forwards.h"


namespace viennacl
{
namespace scheduler
{
namespace detail
{
#define VIENNACL_TRANSLATE_OP_TO_STRING(NAME)   case NAME: return #NAME;

  inline std::string to_string(viennacl::scheduler::op_element op_elem)
  {
    if (op_elem.type_family == OPERATION_UNARY_TYPE_FAMILY)
    {
      switch (op_elem.type)
      {
      VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_ABS_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_ACOS_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_ASIN_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_ATAN_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_CEIL_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_COS_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_COSH_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_EXP_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_FABS_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_FLOOR_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_LOG_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_LOG10_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_SIN_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_SINH_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_SQRT_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_TAN_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_TANH_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_TRANS_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_NORM_1_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_NORM_2_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_NORM_INF_TYPE)

          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_UNARY_MINUS_TYPE)

          default: throw statement_not_supported_exception("Cannot convert unary operation to string");
      }
    }
    else if (op_elem.type_family == OPERATION_BINARY_TYPE_FAMILY)
    {
      switch (op_elem.type)
      {
      VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_ASSIGN_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_INPLACE_ADD_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_INPLACE_SUB_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_ADD_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_SUB_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_MAT_VEC_PROD_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_MAT_MAT_PROD_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_MULT_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_DIV_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_ELEMENT_PROD_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_ELEMENT_DIV_TYPE)
          VIENNACL_TRANSLATE_OP_TO_STRING(OPERATION_BINARY_INNER_PROD_TYPE)

          default: throw statement_not_supported_exception("Cannot convert unary operation to string");
      }
    }
    else if (op_elem.type_family == OPERATION_INVALID_TYPE_FAMILY)
    {
      if (op_elem.type == OPERATION_INVALID_TYPE)
        return "OPERATION_INVALID_TYPE";
      else
        throw statement_not_supported_exception("Unknown invalid operation type when converting to string");
    }
    else
      throw statement_not_supported_exception("Unknown operation family when converting to string");
  }
#undef VIENNACL_TRANSLATE_OP_TO_STRING

#define VIENNACL_TRANSLATE_ELEMENT_TO_STRING(NAME, ELEMENT)   case NAME: ss << "(" << element.ELEMENT << ")"; return #NAME + ss.str();

  inline std::string to_string(viennacl::scheduler::lhs_rhs_element element)
  {
    std::stringstream ss;

    if (element.type_family == COMPOSITE_OPERATION_FAMILY)
    {
      ss << "(" << element.node_index << ")";
      return "COMPOSITE_OPERATION_FAMILY" + ss.str();
    }
    else if (element.type_family == SCALAR_TYPE_FAMILY)
    {
      if (element.subtype == HOST_SCALAR_TYPE)
      {
        ss << ", HOST_SCALAR_TYPE ";
        switch (element.numeric_type)
        {
        VIENNACL_TRANSLATE_ELEMENT_TO_STRING(CHAR_TYPE,   host_char)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UCHAR_TYPE,  host_uchar)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(SHORT_TYPE,  host_short)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(USHORT_TYPE, host_ushort)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(INT_TYPE,    host_int)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UINT_TYPE,   host_uint)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(LONG_TYPE,   host_long)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(ULONG_TYPE,  host_ulong)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(FLOAT_TYPE,  host_float)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(DOUBLE_TYPE, host_double)

            default: throw statement_not_supported_exception("Cannot convert host scalar type to string");
        }
      }
      else
      {
        ss << ", DEVICE_SCALAR_TYPE";
        switch (element.numeric_type)
        {
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(CHAR_TYPE,   scalar_char)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UCHAR_TYPE,  scalar_uchar)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(SHORT_TYPE,  scalar_short)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(USHORT_TYPE, scalar_ushort)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(INT_TYPE,    scalar_int)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UINT_TYPE,   scalar_uint)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(LONG_TYPE,   scalar_long)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(ULONG_TYPE,  scalar_ulong)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(HALF_TYPE,   scalar_half)
        VIENNACL_TRANSLATE_ELEMENT_TO_STRING(FLOAT_TYPE,  scalar_float)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(DOUBLE_TYPE, scalar_double)
            default: throw statement_not_supported_exception("Cannot convert scalar type to string");
        }
      }
    }
    else if (element.type_family == VECTOR_TYPE_FAMILY)
    {
      ss << ", DENSE_VECTOR_TYPE ";
      switch (element.numeric_type)
      {
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(CHAR_TYPE,   vector_char)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UCHAR_TYPE,  vector_uchar)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(SHORT_TYPE,  vector_short)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(USHORT_TYPE, vector_ushort)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(INT_TYPE,    vector_int)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UINT_TYPE,   vector_uint)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(LONG_TYPE,   vector_long)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(ULONG_TYPE,  vector_ulong)
      //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(HALF_TYPE,   vector_half)
      VIENNACL_TRANSLATE_ELEMENT_TO_STRING(FLOAT_TYPE,  vector_float)
          VIENNACL_TRANSLATE_ELEMENT_TO_STRING(DOUBLE_TYPE, vector_double)

          default: throw statement_not_supported_exception("Cannot convert vector type to string");
      }
    }
    else if (element.type_family == MATRIX_TYPE_FAMILY)
    {
      if (element.subtype == DENSE_MATRIX_TYPE)
      {
        ss << ", DENSE_MATRIX_TYPE ";
        switch (element.numeric_type)
        {
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(CHAR_TYPE,   matrix_char)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UCHAR_TYPE,  matrix_uchar)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(SHORT_TYPE,  matrix_short)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(USHORT_TYPE, matrix_ushort)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(INT_TYPE,    matrix_int)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(UINT_TYPE,   matrix_uint)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(LONG_TYPE,   matrix_long)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(ULONG_TYPE,  matrix_ulong)
        //VIENNACL_TRANSLATE_ELEMENT_TO_STRING(HALF_TYPE,   matrix_half)
        VIENNACL_TRANSLATE_ELEMENT_TO_STRING(FLOAT_TYPE,  matrix_float)
            VIENNACL_TRANSLATE_ELEMENT_TO_STRING(DOUBLE_TYPE, matrix_double)

            default: throw statement_not_supported_exception("Cannot convert dense matrix type to string");
        }
      }
      else
        throw statement_not_supported_exception("Cannot convert matrix sub-type to string");
    }
    else if (element.type_family == INVALID_TYPE_FAMILY)
    {
      return "INVALID_TYPE_FAMILY";
    }
    else
      throw statement_not_supported_exception("Unknown operation family when converting to string");
  }

#undef VIENNACL_TRANSLATE_ELEMENT_TO_STRING

} // namespace detail


inline std::ostream & operator<<(std::ostream & os, viennacl::scheduler::statement_node const & s_node)
{
  os << "LHS: " << detail::to_string(s_node.lhs) << ", "
     << "OP: "  << detail::to_string(s_node.op) << ", "
     << "RHS: " << detail::to_string(s_node.rhs);

  return os;
}

namespace detail
{
  inline void print_node(std::ostream & os, viennacl::scheduler::statement const & s, vcl_size_t node_index, vcl_size_t indent = 0)
  {
    typedef viennacl::scheduler::statement::container_type   StatementNodeContainer;
    typedef viennacl::scheduler::statement::value_type       StatementNode;

    StatementNodeContainer const & nodes = s.array();
    StatementNode const & current_node = nodes[node_index];

    for (vcl_size_t i=0; i<indent; ++i)
      os << " ";

    os << "Node " << node_index << ": " << current_node << std::endl;

    if (current_node.lhs.type_family == COMPOSITE_OPERATION_FAMILY)
      print_node(os, s, current_node.lhs.node_index, indent+1);

    if (current_node.rhs.type_family == COMPOSITE_OPERATION_FAMILY)
      print_node(os, s, current_node.rhs.node_index, indent+1);
  }
}

inline std::ostream & operator<<(std::ostream & os, viennacl::scheduler::statement const & s)
{
  detail::print_node(os, s, s.root());
  return os;
}

}
} //namespace viennacl

#endif