CTanh.java

  1. /*
  2.  * @cond LICENSE
  3.  * ######################################################################################
  4.  * # LGPL License                                                                       #
  5.  * #                                                                                    #
  6.  * # This file is part of the LightJason AgentSpeak(L++)                                #
  7.  * # Copyright (c) 2015-19, LightJason (info@lightjason.org)                            #
  8.  * # This program is free software: you can redistribute it and/or modify               #
  9.  * # it under the terms of the GNU Lesser General Public License as                     #
  10.  * # published by the Free Software Foundation, either version 3 of the                 #
  11.  * # License, or (at your option) any later version.                                    #
  12.  * #                                                                                    #
  13.  * # This program is distributed in the hope that it will be useful,                    #
  14.  * # but WITHOUT ANY WARRANTY; without even the implied warranty of                     #
  15.  * # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                      #
  16.  * # GNU Lesser General Public License for more details.                                #
  17.  * #                                                                                    #
  18.  * # You should have received a copy of the GNU Lesser General Public License           #
  19.  * # along with this program. If not, see http://www.gnu.org/licenses/                  #
  20.  * ######################################################################################
  21.  * @endcond
  22.  */

  23. package org.lightjason.agentspeak.action.builtin.math;

  24. import org.lightjason.agentspeak.action.builtin.IBuiltinAction;
  25. import org.lightjason.agentspeak.language.CCommon;
  26. import org.lightjason.agentspeak.language.CRawTerm;
  27. import org.lightjason.agentspeak.language.ITerm;
  28. import org.lightjason.agentspeak.language.execution.IContext;
  29. import org.lightjason.agentspeak.language.fuzzy.CFuzzyValue;
  30. import org.lightjason.agentspeak.language.fuzzy.IFuzzyValue;

  31. import javax.annotation.Nonnegative;
  32. import javax.annotation.Nonnull;
  33. import java.util.List;


  34. /**
  35.  * action for tangens hyperbolic value.
  36.  * Calculates for each unflatten argument
  37.  * \f$ tanh( x_i ) \f$ and fails never
  38.  *
  39.  * {@code [A|B|C] = math/tanh( [1,2], 3 );}
  40.  * @see https://en.wikipedia.org/wiki/Hyperbolic_function
  41.  */
  42. public final class CTanh extends IBuiltinAction
  43. {
  44.     /**
  45.      * serial id
  46.      */
  47.     private static final long serialVersionUID = -5713238239330397757L;

  48.     @Nonnegative
  49.     @Override
  50.     public final int minimalArgumentNumber()
  51.     {
  52.         return 1;
  53.     }

  54.     @Nonnull
  55.     @Override
  56.     public final IFuzzyValue<Boolean> execute( final boolean p_parallel, @Nonnull final IContext p_context,
  57.                                                @Nonnull final List<ITerm> p_argument, @Nonnull final List<ITerm> p_return )
  58.     {
  59.         CCommon.flatten( p_argument )
  60.                .map( ITerm::<Number>raw )
  61.                .mapToDouble( Number::doubleValue )
  62.                .boxed()
  63.                .map( Math::tanh )
  64.                .map( CRawTerm::from )
  65.                .forEach( p_return::add );

  66.         return CFuzzyValue.from( true );
  67.     }

  68. }