/*
GeoGebra - Dynamic Mathematics for Everyone
http://www.geogebra.org
This file is part of GeoGebra.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation.
*/
package org.geogebra.common.kernel.cas;
import org.geogebra.common.kernel.Construction;
import org.geogebra.common.kernel.StringTemplate;
import org.geogebra.common.kernel.algos.AlgoCasBase;
import org.geogebra.common.kernel.arithmetic.Function;
import org.geogebra.common.kernel.arithmetic.FunctionNVar;
import org.geogebra.common.kernel.arithmetic.FunctionVariable;
import org.geogebra.common.kernel.arithmetic.MyArbitraryConstant;
import org.geogebra.common.kernel.commands.Commands;
import org.geogebra.common.kernel.commands.EvalInfo;
import org.geogebra.common.kernel.geos.CasEvaluableFunction;
import org.geogebra.common.kernel.geos.GeoElement;
import org.geogebra.common.kernel.geos.GeoFunction;
import org.geogebra.common.kernel.geos.GeoFunctionNVar;
import org.geogebra.common.kernel.geos.GeoNumberValue;
import org.geogebra.common.kernel.geos.GeoNumeric;
import org.geogebra.common.kernel.kernelND.GeoCurveCartesianND;
/**
* Derivative of a function
*
* @author Markus Hohenwarter
*/
public class AlgoDerivative extends AlgoCasBase {
private GeoNumeric var;
private GeoNumberValue order;
// true -> non-CAS version (faster, used by eg AlgoTangentXXX)
private boolean fast = false;
/**
* @param cons
* construction
* @param label
* label for output
* @param f
* function
* @param var
* variable (may be null)
* @param order
* derivative order (may be null)
* @param info
* evaluation flags
*/
public AlgoDerivative(Construction cons, String label,
CasEvaluableFunction f, GeoNumeric var, GeoNumberValue order,
EvalInfo info) {
this(cons, f, var, order, false, info);
g.toGeoElement().setLabel(label);
}
/**
* @param cons
* construction
* @param label
* label for output
* @param f
* function
* @param var
* variable (may be null)
* @param order
* derivative order (may be null)
* @param fast
* whether to use CAS
* @param info
* evaluation flags
*/
public AlgoDerivative(Construction cons, String label,
CasEvaluableFunction f, GeoNumeric var, GeoNumberValue order,
boolean fast, EvalInfo info) {
this(cons, f, var, order, fast, info);
g.toGeoElement().setLabel(label);
}
/**
* @param cons
* construction
* @param f
* function
* @param info
* evaluation flags
*/
public AlgoDerivative(Construction cons, CasEvaluableFunction f,
EvalInfo info) {
this(cons, f, null, null, false, info);
}
/**
* @param cons
* construction
* @param f
* function
* @param var
* variable (may be null)
* @param order
* derivative order (may be null)
* @param fast
* true to avoid CAS
* @param info
* evaluation flags
*/
public AlgoDerivative(Construction cons, CasEvaluableFunction f,
GeoNumeric var, GeoNumberValue order, boolean fast, EvalInfo info) {
super(cons, f, fast ? Commands.NDerivative : Commands.Derivative, info);
this.var = var;
this.order = order;
this.fast = fast || !info.isUsingCAS();
setInputOutput(); // for AlgoElement
compute();
}
/**
* @param cons
* construction
* @param f
* function to derive
* @param fast
* true to avoid CAS
* @param info
* evaluation flags
*/
public AlgoDerivative(Construction cons, CasEvaluableFunction f,
boolean fast, EvalInfo info) {
this(cons, f, null, null, fast, info);
}
// for AlgoElement
@Override
protected void setInputOutput() {
int length = 1;
if (order != null) {
length++;
}
if (var != null) {
length++;
}
input = new GeoElement[length];
length = 0;
input[0] = f.toGeoElement();
if (var != null) {
input[++length] = var;
}
if (order != null) {
input[++length] = order.toGeoElement();
}
setOnlyOutput(g);
setDependencies(); // done by AlgoElement
}
private MyArbitraryConstant arbconst = new MyArbitraryConstant(this);
@Override
protected void applyCasCommand(StringTemplate tpl) {
int orderInt = order == null ? 1 : (int) Math.round(order.getDouble());
// secret is not the same as fast: preview is fast but not secret
boolean secret = getClassName() == Commands.NDerivative;
if (f instanceof GeoFunction) {
Function funDeriv = ((GeoFunction) f).getFunction()
.getDerivative(orderInt, fast);
if (secret) {
funDeriv.setSecret(this);
}
((GeoFunction) g).setFunction(funDeriv);
((GeoFunction) g).setDefined(true);
return;
}
if (f instanceof GeoCurveCartesianND) {
((GeoCurveCartesianND) g).setDerivative((GeoCurveCartesianND) f,
orderInt);
for (int i = 0; secret
&& i < ((GeoCurveCartesianND) g).getDimension(); i++) {
((GeoCurveCartesianND) g).getFun(i).setSecret(this);
}
return;
}
// var.getLabel() can return a number in wrong alphabet (need ASCII)
String varStr = var != null ? var.getLabel(tpl) : f.getVarString(tpl);
if (f instanceof GeoFunctionNVar) {
FunctionNVar inFun = ((GeoFunctionNVar) f).getFunction();
if (!kernel.useCASforDerivatives()) {
// fast general non-CAS method, output form not so nice
FunctionVariable[] fVars = inFun.getFunctionVariables();
FunctionVariable fv = null;
for (int i = 0; i < fVars.length; i++) {
if (varStr.equals(fVars[i].getSetVarString())) {
fv = fVars[i];
break;
}
}
if (fv == null) {
((GeoFunctionNVar) g).setDefined(false);
return;
}
inFun = inFun.getDerivativeNoCAS(fv, orderInt);
((GeoFunctionNVar) g).setFunction(inFun);
((GeoFunctionNVar) g).setDefined(true);
return;
}
}
sbAE.setLength(0);
sbAE.append("Derivative[%");
sbAE.append(",");
sbAE.append(varStr);
sbAE.append(",");
sbAE.append(order == null ? 1 : (int) Math.round(order.getDouble()));
sbAE.append("]");
// find symbolic derivative of f
g.setUsingCasCommand(sbAE.toString(), f, true, arbconst);
}
@Override
final public String toString(StringTemplate tpl) {
StringBuilder sb = new StringBuilder();
if (var != null) {
// Derivative[ a x^2, x ]
sb.append(super.toString(tpl));
} else {
// 2. Derivative of a x^2
if (order != null) {
String orderStr = order.toGeoElement().getLabel(tpl);
char firstCh = orderStr.charAt(0);
if (firstCh >= '0' && firstCh <= '9') {
// numeric, convert 3 -> 3rd (in current locale)
orderStr = getLoc()
.getOrdinalNumber((int) order.getDouble());
} else {
// symbolic, convert n -> nth (in current locale)
orderStr = getLoc().getPlain("Ath", orderStr);
}
sb.append(getLoc().getPlain("ADerivativeOfB", orderStr,
f.toGeoElement().getLabel(tpl)));
} else {
sb.append(getLoc().getPlain("DerivativeOfA",
f.toGeoElement().getLabel(tpl)));
}
}
if (!fast && !f.toGeoElement().isIndependent()) { // show the symbolic
// representation too
sb.append(": ");
sb.append(g.toGeoElement().getLabel(tpl));
sb.append('(');
sb.append(g.getVarString(tpl));
sb.append(") = ");
sb.append(g.toSymbolicString(tpl));
}
return sb.toString();
}
}