Adds two ObjectiveFunction values together. More...

#include <CompositeOFAdd.hpp>

Inheritance diagram for CompositeOFAdd:

Collaboration diagram for CompositeOFAdd:

Public Member Functions
	CompositeOFAdd (ObjectiveFunction , ObjectiveFunction )

virtual	~CompositeOFAdd ()

virtual bool	concrete_evaluate (PatchData &patch, double &fval, MsqError &err)

virtual msq_std::list < QualityMetric * >	get_quality_metric_list ()

	CompositeOFAdd (ObjectiveFunction , ObjectiveFunction )

virtual	~CompositeOFAdd ()

virtual bool	concrete_evaluate (PatchData &patch, double &fval, MsqError &err)

virtual msq_std::list < QualityMetric * >	get_quality_metric_list ()

Public Member Functions inherited from ObjectiveFunction
	ObjectiveFunction ()

virtual	~ObjectiveFunction ()

bool	evaluate (PatchData &patch, double &fval, MsqError &err)

void	set_gradient_type (GRADIENT_TYPE grad)
	Set gradType to either NUMERICAL_GRADIENT or ANALYTICAL_GRADIENT. More...

bool	compute_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size=0)
	Calls either compute_numerical_gradient or compute_analytical_gradient depending on the value of gradType. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

bool	compute_hessian (PatchData &patch, MsqHessian &hessian, Vector3D *const &grad, double &OF_val, MsqError &err)
	Calls compute_analytical_hessian. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

QualityMetric *	get_quality_metric ()

void	set_quality_metric (QualityMetric *qm)
	Set the value of qMetric. More...

void	set_negate_flag (int neg)
	Set the value of ObjectiveFunction's negateFlag. Unless composite, concrete ObjectiveFunctions should set this flag to to the value of the associated QualityMetric's negateFLag. More...

int	get_negate_flag ()
	Returns negateFlag. More...

	ObjectiveFunction ()

virtual	~ObjectiveFunction ()

bool	evaluate (PatchData &patch, double &fval, MsqError &err)

void	set_gradient_type (GRADIENT_TYPE grad)
	Set gradType to either NUMERICAL_GRADIENT or ANALYTICAL_GRADIENT. More...

bool	compute_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size=0)
	Calls either compute_numerical_gradient or compute_analytical_gradient depending on the value of gradType. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

bool	compute_hessian (PatchData &patch, MsqHessian &hessian, Vector3D *const &grad, double &OF_val, MsqError &err)
	Calls compute_analytical_hessian. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

QualityMetric *	get_quality_metric ()

void	set_quality_metric (QualityMetric *qm)
	Set the value of qMetric. More...

void	set_negate_flag (int neg)
	Set the value of ObjectiveFunction's negateFlag. Unless composite, concrete ObjectiveFunctions should set this flag to to the value of the associated QualityMetric's negateFLag. More...

int	get_negate_flag ()
	Returns negateFlag. More...

Protected Member Functions
bool	compute_analytical_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size)

bool	compute_analytical_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size)

Protected Member Functions inherited from ObjectiveFunction
bool	compute_numerical_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size)
	Non-virtual function which numerically computes the gradient of the Objective Function. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

virtual bool	compute_analytical_hessian (PatchData &, MsqHessian &, Vector3D *const &, double &, MsqError &)

double	get_eps (PatchData &pd, double &local_val, int k, MsqVertex *vertex, MsqError &err)
	Returns eps used in the numerical gradient calculation. More...

void	set_use_local_gradient (bool new_bool)
	Sets useLocalGradient This variable determines whether compute_numercial_gradient can use the most efficient gradient calculation. More...

bool	compute_numerical_gradient (PatchData &patch, Vector3D *const &grad, double &OF_val, MsqError &err, size_t array_size)
	Non-virtual function which numerically computes the gradient of the Objective Function. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'. More...

virtual bool	compute_analytical_hessian (PatchData &, MsqHessian &, Vector3D *const &, double &, MsqError &)

double	get_eps (PatchData &pd, double &local_val, int k, MsqVertex *vertex, MsqError &err)
	Returns eps used in the numerical gradient calculation. More...

void	set_use_local_gradient (bool new_bool)
	Sets useLocalGradient This variable determines whether compute_numercial_gradient can use the most efficient gradient calculation. More...

Private Attributes
ObjectiveFunction *	objFunc1

ObjectiveFunction *	objFunc2

Additional Inherited Members
Public Types inherited from ObjectiveFunction
enum	GRADIENT_TYPE { NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT, NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT }

enum	GRADIENT_TYPE { NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT, NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT }

Detailed Description

Adds two ObjectiveFunction values together.

Definition at line 53 of file includeLinks/CompositeOFAdd.hpp.

Constructor & Destructor Documentation

CompositeOFAdd	(	ObjectiveFunction *	Obj1,
		ObjectiveFunction *	Obj2
	)

Sets the QualityMetric pointer to the metric associated with Obj1 and Obj2 if Obj1 and Obj2 are associated with the same metric. Otherwise, it sets the QualityMetric pointer to NULL. The new ObjectiveFunction's negateFlag is always set to one, because the values produced by obj1 and obj2 have already been multiplied by negative one if it was needed. Defaults to the analytical gradient.

Parameters

Obj1	(ObjectiveFunction*)
Obj2	(ObjectiveFunction*)

Definition at line 54 of file ObjectiveFunction/CompositeOFAdd.cpp.

References ObjectiveFunction::ANALYTICAL_GRADIENT, ObjectiveFunction::get_quality_metric(), CompositeOFAdd::objFunc1, CompositeOFAdd::objFunc2, ObjectiveFunction::set_gradient_type(), ObjectiveFunction::set_negate_flag(), and ObjectiveFunction::set_quality_metric().

                                                        {
   if(Obj1->get_quality_metric()==Obj2->get_quality_metric()){
     set_quality_metric(Obj1->get_quality_metric());
   }
   else
     set_quality_metric(NULL);
   objFunc1=Obj1;
   objFunc2=Obj2;
   set_negate_flag(1);
   set_gradient_type(ObjectiveFunction::ANALYTICAL_GRADIENT);
 }

Here is the call graph for this function:

~CompositeOFAdd ( )

virtual

Definition at line 68 of file ObjectiveFunction/CompositeOFAdd.cpp.

                                {
 
 }

CompositeOFAdd	(	ObjectiveFunction *	,
		ObjectiveFunction *
	)

virtual ~CompositeOFAdd ( )

virtual

Member Function Documentation

bool compute_analytical_gradient	(	PatchData &	patch,
		Vector3D *const &	grad,
		double &	OF_val,
		MsqError &	err,
		size_t	array_size
	)

protectedvirtual

Analytically computes the composite objective function's gradient by combining the gradients returned from objFunc2->compute_gradient() and objFunc2->compute_gradient().

Parameters

patch	The PatchData object for which the objective function gradient is computed.
grad	An array of Vector3D, at least the size of the number of vertices in the patch.
OF_val	The objective function value.
array_size	is the size of the grad Vector3D[] array and must correspond to the number of vertices in the patch.

Reimplemented from ObjectiveFunction.

Definition at line 125 of file ObjectiveFunction/CompositeOFAdd.cpp.

References ObjectiveFunction::compute_gradient(), i, MSQ_ERRZERO, MSQ_FUNCTION_TIMER, PatchData::num_vertices(), CompositeOFAdd::objFunc1, and CompositeOFAdd::objFunc2.

 {
   MSQ_FUNCTION_TIMER( "CompositeOFAdd::compute_analytical_gradient" );
   double second_val=0.0;//store the second objective function val
   OF_val=0.0;
     //get first objective function's gradient
   bool rval=objFunc1->compute_gradient(patch, grad, OF_val, 
                                        err, array_size);  MSQ_ERRZERO(err);
   if(rval){
     int num_vert=patch.num_vertices();
     Vector3D* second_grad = new Vector3D[num_vert];
       //get second objective function's gradient
     rval=objFunc2->compute_gradient(patch, second_grad, second_val,
                                     err, num_vert);
       //if both objective functions were successfully computed, add them
     if(rval){
       //add the two objective function values.
       OF_val+=second_val;
       int i=0;
       for(i=0;i<num_vert;++i){
         grad[i]+=second_grad[i];
       }
         //delete the dynamically allocated space for the second gradient
       delete []second_grad;
     }
   }
     //true if both of the above compute gradient's were successful.
   if(!rval)
     OF_val=0.0;
   return rval;
 }

Here is the call graph for this function:

bool compute_analytical_gradient	(	PatchData &	patch,
		Vector3D *const &	grad,
		double &	OF_val,
		MsqError &	err,
		size_t	array_size
	)

protectedvirtual

Fills an array of Vector3D, grad, with the gradient of the objective function computed using the gradient of the quality metric. If the function has not been over-riden in the concrete Objective Function, the base class implementation prints a warning and then defaults to numerical gradient. Function returns 'false' if the patch is not within a required feasible regeion. Otherwise, it returns 'true'.

Parameters

patch	The PatchData object for which the objective function gradient is computed.
grad	An array of Vector3D, at least the size of the number of vertices in the patch.
OF_val	is set to the value of the objective function.
array_size	is the size of the grad Vector3D[] array and must correspond to the number of vertices in the patch.

Reimplemented from ObjectiveFunction.

virtual bool concrete_evaluate	(	PatchData &	patch,
		double &	fval,
		MsqError &	err
	)

virtual

Evaluate the objective function on a given patch.

Implements ObjectiveFunction.

bool concrete_evaluate	(	PatchData &	patch,
		double &	fval,
		MsqError &	err
	)

virtual

Compute fval= objFunc1->evaluate(patch,err)+objFunc2->evaluate(patch,err). Note that since objFunc1 and objFunc2's evaluate() functions are called (as opposed to their concrete_evaluates) the returned values have already been multiplied by the respective negateFlag (that is, if objFunc1 (or objFunc2) needed to be maximized then the value has been multiplied by negative one so that it may be minimized instead.) Function returns `false' if either objFunc1->concrete_evaluate() or objFunc2->concrete_evaluate() returns `false'; otherwise, function returns `true'.

Implements ObjectiveFunction.

Definition at line 95 of file ObjectiveFunction/CompositeOFAdd.cpp.

References ObjectiveFunction::evaluate(), MSQ_CHKERR, CompositeOFAdd::objFunc1, and CompositeOFAdd::objFunc2.

                                                      {
   double second_val=0.0;
     //If patch is invalid
   bool b = objFunc1->evaluate( patch, fval, err );
   if (MSQ_CHKERR(err) || !b) { 
     fval=0.0;
     return false;
   }
   b = objFunc2->evaluate(patch, second_val, err);
   if (MSQ_CHKERR(err) || !b) {
     fval=0.0;
     return false;
   }
   fval+=second_val;
   return true;
 }

Here is the call graph for this function:

msq_std::list< QualityMetric * > get_quality_metric_list ( )

virtual

Returns the QualityMetric list associated with objFunc1 merged with the QualityMetric list associated with objFunc2. The entries in this merged list may not be unique.

Reimplemented from ObjectiveFunction.

Definition at line 76 of file ObjectiveFunction/CompositeOFAdd.cpp.

References ObjectiveFunction::get_quality_metric_list(), CompositeOFAdd::objFunc1, and CompositeOFAdd::objFunc2.

 {
   msq_std::list<QualityMetric*> temp_list=objFunc1->get_quality_metric_list();
   msq_std::list<QualityMetric*> temp_list2=objFunc2->get_quality_metric_list();
   temp_list.merge(temp_list2);
   return temp_list;
     
 }