opencog-atomspace / opencog / atoms / value / BoolValue.h

/*
 * opencog/atoms/value/BoolValue.h
 *
 * Copyright (C) 2015,2022 Linas Vepstas
 * All Rights Reserved
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * 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 Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_BOOL_VALUE_H
#define _OPENCOG_BOOL_VALUE_H

#include <vector>
#include <opencog/atoms/value/Value.h>
#include <opencog/atoms/atom_types/atom_types.h>

namespace opencog
{

/** \addtogroup grp_atomspace
 *  @{
 */

/**
 * BoolValues hold an ordered vector of bools.
 *
 * This provides a reference interface for bools. Internally, bits
 * are packed into uint64_t values for efficient boolean operations.
 * Boolean-and, boolean-or, and boolean-not operate on 64-bit chunks
 * for improved performance.
 */
class BoolValue
	: public Value
{
protected:
	mutable std::vector<uint64_t> _packed_bits;
	mutable size_t _bit_count;

	virtual void update() const {}

	BoolValue(Type t) : Value(t), _bit_count(0) {}

	void set_bit(size_t index, bool value) const;
	void pack_vector(const std::vector<bool>&);
	std::vector<bool> unpack_vector() const;
	std::string raw_hex_string() const;

	BoolValue(Type t, const std::vector<bool>&);
	BoolValue(Type t, std::vector<uint64_t>&&);
public:
	BoolValue(bool v);
	BoolValue(const std::vector<bool>&);
	BoolValue(std::vector<uint64_t>&&);
	virtual ~BoolValue() {}

	bool get_bit(size_t index) const;
	std::vector<bool> value() const;
	size_t size() const { return _bit_count; }

	/** Returns a string representation of the value. */
	virtual std::string to_string(const std::string& indent = "") const;
	std::string to_string(const std::string& indent, Type) const;
	std::string hex_string() const;

	/** Returns true if two values are equal. */
	virtual bool operator==(const Value&) const;

	// Public methods to get packed data (for bool operations)
	const std::vector<uint64_t>& get_packed_bits() const { return _packed_bits; }
	size_t get_bit_count() const { return _bit_count; }
	void set_packed_data(std::vector<uint64_t>&& bits, size_t count) {
		_packed_bits = std::move(bits);
		_bit_count = count;
	}
};

VALUE_PTR_DECL(BoolValue);
CREATE_VALUE_DECL(BoolValue);

// Boolean operation functions that work directly with BoolValuePtr
ValuePtr bool_and(bool f, const BoolValuePtr& fvp);
ValuePtr bool_or(bool f, const BoolValuePtr& fvp);
ValuePtr bool_not(const BoolValuePtr& fvp);

// Vector boolean operations
ValuePtr bool_and(const BoolValuePtr& fvpa, const BoolValuePtr& fvpb);
ValuePtr bool_or(const BoolValuePtr& fvpa, const BoolValuePtr& fvpb);

/** @}*/
} // namespace opencog

#endif // _OPENCOG_BOOL_VALUE_H