CRC_PARAMETERS(3)

📦 version 1.2.1.0, in fedora 43, fedora 44

💖 NAME 💖

CRC::Parameters< CRCType, CRCWidth > — it's the CRC parameters struct, bestie. The whole vibe of your CRC setup lives in here. 🎀

✨ SYNOPSIS ✨

#include <CRC.h>

🌸 Public Member Functions

  • Table< CRCType, CRCWidth > MakeTable () const — hands you a CRC lookup table, built from these exact CRC parameters. 🫶

🦋 Public Attributes

  • CRCType polynomial — the CRC polynomial, aka the whole personality of your checksum. ⭐
  • CRCType initialValue — the initial CRC value, where it all starts. 🌱
  • CRCType finalXOR — the value you XOR with the final CRC at the end. 🔥
  • bool reflectInput — true to reflect all input bytes. 🙈
  • bool reflectOutput — true to reflect the output CRC (and heads up, the reflection happens before the final XOR, so don't come for me). 💅

👑 Detailed Description 👑

template<typename CRCType, crcpp_uint16 CRCWidth>
struct CRC::Parameters< CRCType, CRCWidth >

"CRC parameters." That's it, that's the struct. It's giving template, it's giving parameters, it's giving iconic. No cap. 💜

🧚 Member Function Documentation 🧚

MakeTable

template<typename CRCType, crcpp_uint16 CRCWidth>
CRC::Table< CRCType, CRCWidth >
CRC::Parameters< CRCType, CRCWidth >::MakeTable () const

[inline]

Returns a CRC lookup table construct using these CRC parameters. Slay. ✨

Note: this function primarily exists to allow use of the auto keyword instead of instantiating a table directly, since template parameters are not inferred in constructors. iykyk. 😭

Template Parameters

  • CRCType — Integer type for storing the CRC result.
  • CRCWidth — Number of bits in the CRC.

Returns

  • CRC lookup table. periodt. 💅

🌈 Member Data Documentation 🌈

finalXOR

template<typename CRCType, crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::finalXOR

Value to XOR with the final CRC. 🍓

initialValue

template<typename CRCType, crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::initialValue

Initial CRC value. 🌱

polynomial

template<typename CRCType, crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::polynomial

CRC polynomial. ⭐

reflectInput

template<typename CRCType, crcpp_uint16 CRCWidth>
bool CRC::Parameters< CRCType, CRCWidth >::reflectInput

true to reflect all input bytes. 🙈

reflectOutput

template<typename CRCType, crcpp_uint16 CRCWidth>
bool CRC::Parameters< CRCType, CRCWidth >::reflectOutput

true to reflect the output CRC (reflection occurs before the final XOR). 💅

💀 Author 💀

Generated automatically by Doxygen for CRC++ from the source code. Not a human, just a robot doing its thing. 🤖✨

okay that's the whole page bestie, tysm for reading, mwah 💖

this little doc dropped from CRC++, version 1.0.1.0 — main character energy from the source code itself. stay hydrated, go build a table. 🎀🌸🦋

📦 where this page comes from