| IGLib 1.4 The IGLib base library for development of numerical, technical and business applications.

- Main Page
- Namespaces
- Classes
- Files
- Directories

- Class List
- Class Index
- Class Hierarchy
- Class Members

Properties

# IG::Num::IRealFunctionPenalty Interface Reference

Interface that must be satisfied by penalty functions. Penalty functions have small values where argument is less than 0, and grow fast where their argument is positive. More...

Inheritance diagram for IG::Num::IRealFunctionPenalty:
[legend]
Collaboration diagram for IG::Num::IRealFunctionPenalty:
[legend]

List of all members.

## Properties
bool | IsFiniteSupport`[get]`
| Whether penalty function has finite support (meaning that it is 0 for all arguments less than some specific value).
bool | IsAbsoluteDifferentiable`[get]`
| True if absolute value is differentiable, false otherwise. Differentiability of absolute value at 0 is important for penalty functions used for equality constraints.
bool | IsAbsoluteTwiceDifferentiable`[get]`
| True if absolute value is twoce differentiable, false otherwise. Differentiability of absolute value at 0 is important for penalty functions used for equality constraints.
bool | CanSetMaxZero`[get]`
| Whether maximal value for which penalty function is zero can be set.
bool | CanSetBarrierLength`[get]`
| Whether the gap can be set.
bool | CanSetBarrierHeight`[get]`
| Whether the height can be set.
double | MaxZero`[get, set]`
| Maximal value for which penalty function is zero.
double | BarrierLength`[get, set]`
| Gap - characteristic length of transition area on which penalty function grows for about (or sometimes exactly, especially in case of finite support) characteristic height.
double | BarrierHeight`[get, set]`
| Characteristic heitht of transition area, usually value of the penalty function at the end of transition area.

## Detailed Description

Interface that must be satisfied by penalty functions. Penalty functions have small values where argument is less than 0, and grow fast where their argument is positive.

$A Igor xx;

## Property Documentation

bool IG::Num::IRealFunctionPenalty::IsFiniteSupport`[get]`

Whether penalty function has finite support (meaning that it is 0 for all arguments less than some specific value).

Implemented in IG::Num::Func::PenaltyPower.

bool IG::Num::IRealFunctionPenalty::IsAbsoluteDifferentiable`[get]`

True if absolute value is differentiable, false otherwise. Differentiability of absolute value at 0 is important for penalty functions used for equality constraints.

Implemented in IG::Num::Func::PenaltyPower.

bool IG::Num::IRealFunctionPenalty::IsAbsoluteTwiceDifferentiable`[get]`

True if absolute value is twoce differentiable, false otherwise. Differentiability of absolute value at 0 is important for penalty functions used for equality constraints.

Implemented in IG::Num::Func::PenaltyPower.

bool IG::Num::IRealFunctionPenalty::CanSetMaxZero`[get]`

Whether maximal value for which penalty function is zero can be set.

Implemented in IG::Num::Func::PenaltyPower.

bool IG::Num::IRealFunctionPenalty::CanSetBarrierLength`[get]`

Whether the gap can be set.

Implemented in IG::Num::Func::PenaltyPower.

bool IG::Num::IRealFunctionPenalty::CanSetBarrierHeight`[get]`

Whether the height can be set.

Implemented in IG::Num::Func::PenaltyPower.

double IG::Num::IRealFunctionPenalty::MaxZero`[get, set]`

Maximal value for which penalty function is zero.

Implemented in IG::Num::Func::PenaltyPower.

double IG::Num::IRealFunctionPenalty::BarrierLength`[get, set]`

Gap - characteristic length of transition area on which penalty function grows for about (or sometimes exactly, especially in case of finite support) characteristic height.

Implemented in IG::Num::Func::PenaltyPower.

double IG::Num::IRealFunctionPenalty::BarrierHeight`[get, set]`

Characteristic heitht of transition area, usually value of the penalty function at the end of transition area.

Implemented in IG::Num::Func::PenaltyPower.

The documentation for this interface was generated from the following file:

- FunctionRealPenalty.cs

All Classes Namespaces Files Functions Variables Enumerations Properties Events