numeral.hpp

Go to the documentation of this file.

 
/******************************************************************************
 * MODULE     : numberal.hpp
 * DESCRIPTION: convertions for various numberal systems
 * COPYRIGHT  : (C) 2013  Francois Poulain
 *******************************************************************************
 * This software falls under the GNU general public license version 3 or later.
 * It comes WITHOUT ANY WARRANTY WHATSOEVER. For details, see the file LICENSE
 * in the root directory or <http://www.gnu.org/licenses/gpl-3.0.html>.
 ******************************************************************************/
 
#pragma once
 
#include "basic.hpp"
#include "string.hpp"
#include <stdint.h>
 
namespace lolly {
namespace data {
/**
 * @brief Generates a Roman numeral string for an integer.
 *
 * @param nr The integer to be converted to Roman numeral.
 * @return A string representing the Roman numeral.
 */
string to_roman (int32_t nr);
 
/**
 * @brief Generates an uppercase Roman numeral string for an integer.
 *
 * @param nr The integer to be converted to Roman numeral.
 * @return A string representing the uppercase Roman numeral.
 */
string to_Roman (int32_t nr);
 
/**
 * @brief Generates a Chinese numeral for a given integer.
 *
 * @param nr The integer to be converted to a Chinese numeral.
 * @return A string representing the Chinese numeral.
 */
string to_hanzi (int32_t nr);
 
/**
 * @brief Converts an 8-bit unsigned integer to a fixed-length (2) hex string.
 *
 * @param i The integer to be converted to a fixed-length hex string.
 * @return The fixed-length (2) hexadecimal string representation of the input
 * integer.
 */
string to_padded_hex (uint8_t i);
 
/**
 * @brief Converts an integer to a hexadecimal string.
 *
 * @param i The integer to be converted to a hexadecimal string.
 * @return The hexadecimal string representation of the input integer.
 */
string to_hex (int i);
 
string to_Hex (int i);
 
/**
 * @brief Converts a pointer to a hexadecimal string.
 *
 * @param ptr The pointer to be converted to a hexadecimal string.
 * @return The hexadecimal string representation of the input pointer.
 */
string to_hex (pointer ptr);
 
string to_Hex (pointer ptr);
 
/**
 * @brief Converts a hexadecimal string to an integer.
 *
 * This function takes a hexadecimal string as input and converts it into its
 * integer representation.
 *
 * @param s The hexadecimal string to be converted to an integer.
 * @return The integer representation of the input hexadecimal string.
 */
int from_hex (string s);
 
/**
 * @brief Converts an unsigned integer to a hexadecimal string with a fixed
 * length.
 *
 * @param i The integer to be converted to a hexadecimal string.
 * @param len The length of the output hexadecimal string.
 * @return The fixed-length hexadecimal string representation of the input
 * integer.
 */
string as_hexadecimal (int i, int length);
 
/**
 * @brief Converts an unsigned integer to a hexadecimal string.
 *
 * @param i The integer to be converted to a hexadecimal string.
 * @return The hexadecimal string representation of the input integer.
 */
string uint32_to_Hex (uint32_t i);
 
/**
 * @brief Converts a binary stream to its hexadecimal represention.
 *
 * @param bin The binary data to be converted to a hexadecimal string.
 * @return The hexadecimal string representation of the input binary.
 */
string binary_to_hexadecimal (string bin);
 
} // namespace data
} // namespace lolly