mariadb-columnstore-engine/dbcon/execplan/simplecolumn_decimal.h

/* Copyright (C) 2014 InfiniDB, Inc.
   Copyright (C) 2019 MariaDB Corporation

   This program 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.

   This program 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 this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
   MA 02110-1301, USA. */

/***********************************************************************
 *   $Id: simplecolumn_decimal.h 9635 2013-06-19 21:42:30Z bwilkinson $
 *
 *
 ***********************************************************************/
/** @file */

#pragma once
#include <iostream>
#include <string>
#include <cmath>

#include "simplecolumn.h"
#include "objectreader.h"
#include "joblisttypes.h"
#include "rowgroup.h"
#include "dataconvert.h"

/**
 * Namespace
 */
namespace execplan
{
/**
 * @brief A class to represent a simple returned column
 *
 * This class is a specialization of class ReturnedColumn that handles
 * a column name.
 */
template <int len>
class SimpleColumn_Decimal : public SimpleColumn
{
  /**
   * Public stuff
   */
 public:
  /** Constructors */
  SimpleColumn_Decimal();
  explicit SimpleColumn_Decimal(const std::string& token, const uint32_t sessionID = 0);
  SimpleColumn_Decimal(const std::string& schema, const std::string& table, const std::string& col,
                       const bool isColumnStore, const uint32_t sessionID = 0);
  explicit SimpleColumn_Decimal(const SimpleColumn& rhs, const uint32_t sessionID = 0);

  /** Destructor */
  ~SimpleColumn_Decimal() override = default;

  inline SimpleColumn_Decimal* clone() const override
  {
    return new SimpleColumn_Decimal<len>(*this);
  }

  /** Evaluate methods */
  inline const utils::NullString& getStrVal(rowgroup::Row& row, bool& isNull) override;
  inline int64_t getIntVal(rowgroup::Row& row, bool& isNull) override;
  inline float getFloatVal(rowgroup::Row& row, bool& isNull) override;
  inline double getDoubleVal(rowgroup::Row& row, bool& isNull) override;
  inline long double getLongDoubleVal(rowgroup::Row& row, bool& isNull) override;
  inline IDB_Decimal getDecimalVal(rowgroup::Row& row, bool& isNull) override;

  /** The serialize interface */
  void serialize(messageqcpp::ByteStream&) const override;
  void unserialize(messageqcpp::ByteStream&) override;
  uint64_t fNullVal;

  std::string toCppCode(IncludeSet& includes) const override;

 private:
  void setNullVal();
};

template <int len>
std::string SimpleColumn_Decimal<len>::toCppCode(IncludeSet& includes) const
{
  includes.insert("simplecolumn_decimal.h");
  std::stringstream ss;
  ss << "SimpleColumn_Decimal<" << len << ">(" << std::quoted(fSchemaName) << ", " << std::quoted(fTableName)
     << ", " << std::quoted(fColumnName) << ", " << fisColumnStore << ", " << sessionID() << ")";

  return ss.str();
}

template <int len>
SimpleColumn_Decimal<len>::SimpleColumn_Decimal() : SimpleColumn()
{
  setNullVal();
}

template <int len>
SimpleColumn_Decimal<len>::SimpleColumn_Decimal(const std::string& token, const uint32_t sessionID)
 : SimpleColumn(token, sessionID)
{
  setNullVal();
}

template <int len>
SimpleColumn_Decimal<len>::SimpleColumn_Decimal(const std::string& schema, const std::string& table,
                                                const std::string& col, const bool isColumnStore,
                                                const uint32_t sessionID)
 : SimpleColumn(schema, table, col, isColumnStore, sessionID)
{
  setNullVal();
}

template <int len>
SimpleColumn_Decimal<len>::SimpleColumn_Decimal(const SimpleColumn& rhs, const uint32_t sessionID)
 : SimpleColumn(rhs, sessionID)
{
  setNullVal();
}

template <int len>
void SimpleColumn_Decimal<len>::setNullVal()
{
  switch (len)
  {
    case 8: fNullVal = joblist::BIGINTNULL; break;

    case 4: fNullVal = joblist::INTNULL; break;

    case 2: fNullVal = joblist::SMALLINTNULL; break;

    case 1: fNullVal = joblist::TINYINTNULL; break;
    case 16:
      // TODO MCOL-641
      // fallthrough
    default: fNullVal = joblist::BIGINTNULL;
  }
}

template <int len>
inline const utils::NullString& SimpleColumn_Decimal<len>::getStrVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
  {
    isNull = true;
    fResult.strVal.dropString();
  }
  else
  {
    datatypes::Decimal dec((int64_t)row.getIntField<len>(fInputIndex), fResultType.scale,
                           fResultType.precision);
    fResult.strVal.assign(dec.toString());
  }
  return fResult.strVal;
}

template <int len>
inline int64_t SimpleColumn_Decimal<len>::getIntVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
    isNull = true;

  // TODO: fix double division to integer division
  return (int64_t)(row.getIntField<len>(fInputIndex) / datatypes::scaleDivisor<double>(fResultType.scale));
}

template <int len>
inline float SimpleColumn_Decimal<len>::getFloatVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
    isNull = true;

  return (row.getIntField<len>(fInputIndex) / datatypes::scaleDivisor<double>(fResultType.scale));
}

template <int len>
inline double SimpleColumn_Decimal<len>::getDoubleVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
    isNull = true;

  return (row.getIntField<len>(fInputIndex) / datatypes::scaleDivisor<double>(fResultType.scale));
}

template <int len>
inline long double SimpleColumn_Decimal<len>::getLongDoubleVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
    isNull = true;

  return (row.getIntField<len>(fInputIndex) / datatypes::scaleDivisor<long double>(fResultType.scale));
}

template <int len>
inline IDB_Decimal SimpleColumn_Decimal<len>::getDecimalVal(rowgroup::Row& row, bool& isNull)
{
  if (row.equals<len>(fNullVal, fInputIndex))
    isNull = true;

  fResult.decimalVal.value = (int64_t)row.getIntField<len>(fInputIndex);
  fResult.decimalVal.precision = fResultType.precision;
  fResult.decimalVal.scale = fResultType.scale;
  return fResult.decimalVal;
}

template <int len>
void SimpleColumn_Decimal<len>::serialize(messageqcpp::ByteStream& b) const
{
  switch (len)
  {
    case 1: b << (ObjectReader::id_t)ObjectReader::SIMPLECOLUMN_DECIMAL1; break;

    case 2: b << (ObjectReader::id_t)ObjectReader::SIMPLECOLUMN_DECIMAL2; break;

    case 4: b << (ObjectReader::id_t)ObjectReader::SIMPLECOLUMN_DECIMAL4; break;

    case 8:
      b << (ObjectReader::id_t)ObjectReader::SIMPLECOLUMN_DECIMAL8;
      break;
      // TODO MCOL-641
      // case 16:
  }

  SimpleColumn::serialize(b);
}

template <int len>
void SimpleColumn_Decimal<len>::unserialize(messageqcpp::ByteStream& b)
{
  switch (len)
  {
    case 1: ObjectReader::checkType(b, ObjectReader::SIMPLECOLUMN_DECIMAL1); break;

    case 2: ObjectReader::checkType(b, ObjectReader::SIMPLECOLUMN_DECIMAL2); break;

    case 4: ObjectReader::checkType(b, ObjectReader::SIMPLECOLUMN_DECIMAL4); break;

    case 8:
      ObjectReader::checkType(b, ObjectReader::SIMPLECOLUMN_DECIMAL8);
      break;
      // TODO MCOL-641
      // case 16:
  }

  SimpleColumn::unserialize(b);
}

}  // namespace execplan