opencog-atomspace / opencog / atoms / columnvec / FloatColumn.cc

/*
 * FloatColumn.cc
 *
 * Copyright (C) 2015, 2022, 2025 Linas Vepstas
 *
 * Author: Linas Vepstas <linasvepstas@gmail.com>  January 2009
 *
 * 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.
 */

#include <opencog/atoms/core/NumberNode.h>
#include <opencog/atoms/value/LinkValue.h>
#include <opencog/atoms/value/FloatValue.h>

#include "FloatColumn.h"

using namespace opencog;

FloatColumn::FloatColumn(const HandleSeq&& oset, Type t)
	: Link(std::move(oset), t)
{
	if (not nameserver().isA(t, FLOAT_COLUMN))
	{
		const std::string& tname = nameserver().getTypeName(t);
		throw InvalidParamException(TRACE_INFO,
			"Expecting a FloatColumn, got %s", tname.c_str());
	}
}

// ---------------------------------------------------------------

/// Return a FloatValue vector.
ValuePtr FloatColumn::do_handle_loop(AtomSpace* as, bool silent,
                                     const HandleSeq& hseq)
{
	std::vector<double> dvec;
	dvec.reserve(hseq.size());
	for (const Handle& h : hseq)
	{
		ValuePtr vp(h->execute(as, silent));

		// Expecting exactly one float per item. That's because
		// I don't know what it means if there is more than one,
		// flattening seems like the wrong thing to do.
		if (1 != vp->size())
			throw RuntimeException(TRACE_INFO,
				"Expecting exactly one number per item, got %lu\n",
				vp->size());

		if (vp->is_type(FLOAT_VALUE))
			dvec.push_back(FloatValueCast(vp)->value()[0]);
		else if (vp->is_type(NUMBER_NODE))
			dvec.push_back(NumberNodeCast(vp)->get_value());
		else
			throw RuntimeException(TRACE_INFO,
				"Expecting numeric value, got %s\n",
				vp->to_string().c_str());
	}

	return createFloatValue(std::move(dvec));
}

// ---------------------------------------------------------------

/// Return a FloatValue vector.
ValuePtr FloatColumn::do_execute(AtomSpace* as, bool silent)
{
	// If the given Atom is executable, then execute it.
	Handle base(_outgoing[0]);
	if (base->is_executable())
	{
		ValuePtr vpe(base->execute(as, silent));
		if (vpe->is_atom())
			base = HandleCast(vpe);
		else
		{
			if (vpe->is_type(FLOAT_VALUE))
				return vpe;

			if (not vpe->is_type(LINK_VALUE))
				throw RuntimeException(TRACE_INFO,
					"Expecting LinkValue, got %s\n",
					vpe->to_string().c_str());

			// If we are here, we've got a LinkValue.
			// Inside of loop is cut-n-paste of that below.
			std::vector<double> dvec;
			dvec.reserve(vpe->size());
			for (ValuePtr vp : LinkValueCast(vpe)->value())
			{
				// Execute, if its a handle. Is that overkill, or is
				// it needed? When would a vector of functions arise?
				if (vp->is_atom())
					vp = HandleCast(vp)->execute(as, silent);

				// Expecting exactly one float per item. That's because
				// I don't know what it means if there is more than one,
				// flattening seems like the wrong thing to do.
				if (1 != vp->size())
					throw RuntimeException(TRACE_INFO,
						"Expecting exactly one number per item, got %lu\n"
						"\tMaybe you want TransposeColumn instead?\n",
						vp->size());

				if (vp->is_type(FLOAT_VALUE))
					dvec.push_back(FloatValueCast(vp)->value()[0]);
				else if (vp->is_type(NUMBER_NODE))
					dvec.push_back(NumberNodeCast(vp)->get_value());
				else
					throw RuntimeException(TRACE_INFO,
						"Expecting numeric value, got %s\n",
						vp->to_string().c_str());
			}
			return createFloatValue(std::move(dvec));
		}
	}

	// If we are here, then base is an atom.
	if (base->is_type(NUMBER_NODE))
	{
		std::vector<double> nums(NumberNodeCast(base)->value());
		return createFloatValue(std::move(nums));
	}

	// If we are here, then base is an link. Expect
	// it to contain things that evaluate to a double
	return do_handle_loop(as, silent, base->getOutgoingSet());
}

// ---------------------------------------------------------------

/// Return a FloatValue vector.
ValuePtr FloatColumn::execute(AtomSpace* as, bool silent)
{
	if (1 == _outgoing.size())
		return do_execute(as, silent);

	return do_handle_loop(as, silent, _outgoing);
}

DEFINE_LINK_FACTORY(FloatColumn, FLOAT_COLUMN)

/* ===================== END OF FILE ===================== */