CSinglePercentile.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.statistic;

  24. import org.apache.commons.math3.stat.descriptive.DescriptiveStatistics;
  25. import org.lightjason.agentspeak.action.builtin.IBuiltinAction;
  26. import org.lightjason.agentspeak.language.CCommon;
  27. import org.lightjason.agentspeak.language.CRawTerm;
  28. import org.lightjason.agentspeak.language.ITerm;
  29. import org.lightjason.agentspeak.language.execution.IContext;
  30. import org.lightjason.agentspeak.language.fuzzy.CFuzzyValue;
  31. import org.lightjason.agentspeak.language.fuzzy.IFuzzyValue;

  32. import javax.annotation.Nonnull;
  33. import java.util.List;
  34. import java.util.stream.Collectors;


  35. /**
  36.  * returns for any static object a percentile value.
  37.  * The actions reutnrs for any statistic value the
  38.  * given percentile value and the action fails on wrong input
  39.  *
  40.  * {@code [V1|V2|V3] = math/statistic/multiplepercentile( 2, Statistic1, [Statistic2, Statistic3] );}
  41.  */
  42. public final class CSinglePercentile extends IBuiltinAction
  43. {
  44.     /**
  45.      * serial id
  46.      */
  47.     private static final long serialVersionUID = -1554327666105611014L;

  48.     /**
  49.      * ctor
  50.      */
  51.     public CSinglePercentile()
  52.     {
  53.         super( 3 );
  54.     }

  55.     @Override
  56.     public final int minimalArgumentNumber()
  57.     {
  58.         return 2;
  59.     }

  60.     @Nonnull
  61.     @Override
  62.     public final IFuzzyValue<Boolean> execute( final boolean p_parallel, @Nonnull final IContext p_context, @Nonnull final List<ITerm> p_argument,
  63.                                                @Nonnull final List<ITerm> p_return
  64.     )
  65.     {
  66.         final List<ITerm> l_arguments = CCommon.flatten( p_argument ).collect( Collectors.toList() );
  67.         if ( l_arguments.size() < 2 )
  68.             return CFuzzyValue.from( false );

  69.         final double l_value = l_arguments.get( 0 ).<Number>raw().doubleValue();
  70.         l_arguments.stream()
  71.                    .skip( 1 )
  72.                    .mapToDouble( i -> i.<DescriptiveStatistics>raw().getPercentile( l_value ) )
  73.                    .mapToObj( CRawTerm::from )
  74.                    .forEach( p_return::add );

  75.         return CFuzzyValue.from( true );
  76.     }


  77. }