chemical/symmetry/BaseData.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2026 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/chemical/common/SymmetryTypes.h"
#include "bio/chemical/symmetry/Symmetry.h"
#include "bio/common/macro/LanguageMacros.h"
 
#include <cstddef>
 
//@formatter:off
#if BIO_CPP_VERSION < 11
    #include <stdint.h>
#else
    #include <cstdint>
#endif
//@formatter:on
 
namespace bio {
namespace chemical {
namespace base_data {
 
// --- Kind checks ---------------------------------------------------------
 
bool IsArray(const Symmetry& symmetry);
bool IsMap(const Symmetry& symmetry);
bool IsMapEntry(const Symmetry& symmetry);
bool IsTag(const Symmetry& symmetry);
 
bool IsBaseDataStructural(const Symmetry& symmetry);
 
// --- Array ---------------------------------------------------------------
 
void InitArray(Symmetry& symmetry);
 
bool ArrayAppend(Symmetry& symmetry, Pointer< physical::Symmetry > child);
 
std::size_t ArraySize(const Symmetry& symmetry);
 
Pointer< physical::Symmetry > ArrayAt(Symmetry& symmetry, std::size_t index);
Pointer< const physical::Symmetry > ArrayAt(const Symmetry& symmetry, std::size_t index);
 
// --- Map & MapEntry ------------------------------------------------------
 
void InitMap(Symmetry& symmetry);
 
Pointer< Symmetry > MakeMapEntry(Pointer< physical::Symmetry > key, Pointer< physical::Symmetry > value);
 
bool MapAppend(Symmetry& symmetry, Pointer< Symmetry > entry);
 
std::size_t MapSize(const Symmetry& symmetry);
 
Pointer< Symmetry > MapEntryAt(Symmetry& symmetry, std::size_t index);
Pointer< const Symmetry > MapEntryAt(const Symmetry& symmetry, std::size_t index);
 
Pointer< physical::Symmetry > MapEntryKey(Symmetry& entry);
Pointer< const physical::Symmetry > MapEntryKey(const Symmetry& entry);
Pointer< physical::Symmetry > MapEntryValue(Symmetry& entry);
Pointer< const physical::Symmetry > MapEntryValue(const Symmetry& entry);
 
// --- Tag -----------------------------------------------------------------
 
void InitTag(Symmetry& symmetry, uint64_t tagNumber);
 
bool TagSetValue(Symmetry& symmetry, Pointer< physical::Symmetry > value);
 
bool TryGetTagNumber(const Symmetry& symmetry, uint64_t& out);
 
Pointer< physical::Symmetry > TagValue(Symmetry& symmetry);
Pointer< const physical::Symmetry > TagValue(const Symmetry& symmetry);
 
// --- Generic helpers -----------------------------------------------------
 
void ClearChildren(Symmetry& symmetry);
 
} //base_data namespace
} //chemical namespace
} //bio namespace