node.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2014-2018 Carsten Sonne Larsen <cs@innolan.net>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Project homepage:
 * https://amath.innolan.net
 * 
 */

#ifndef AMATH_FUNCTION_NODE_H
#define AMATH_FUNCTION_NODE_H

#include "../nodes.h"

/**
 * @brief   Represents a mathematical function in a syntax tree.
 * @details
 * Function nodes in syntax trees can both be well known functions like
 * cosine (cos) and also user defined functions. The function node represents
 * a function call and not a function definition.
 *
 * A formal description of mathematical functions can be found at Wikipedia:
 * https://wikipedia.org/wiki/Function_(mathematics)
 *
 * When instantiating a function node an argument must be supplied. The argument
 * is a pointer to an expression node representing the value which should be used
 * when computing the function value.
 *
 */
class FunctionNode : public ExpressionNode
{
public:
    explicit FunctionNode(ExpressionNode* expression, char* text, char* sys);
    ~FunctionNode();

    int GetPrecedence();
    char* GetText();
    virtual SyntaxNode* GetNext();
    virtual void Attach(SyntaxNode* node);
    virtual void Detach(SyntaxNode* node);
    virtual void Replace(SyntaxNode* n, SyntaxNode* x);

protected:
    virtual char* GetNodeText();

    ExpressionNode* expression;
    char* name;
    char* sysname;
};

#endif