de.cesr.more.param
Enum MNetBuildWsPa

java.lang.Object
  extended by java.lang.Enum<MNetBuildWsPa>
      extended by de.cesr.more.param.MNetBuildWsPa
All Implemented Interfaces:
de.cesr.parma.core.PmParameterDefinition, Serializable, Comparable<MNetBuildWsPa>

public enum MNetBuildWsPa
extends Enum<MNetBuildWsPa>
implements de.cesr.parma.core.PmParameterDefinition

Parameter definitions used for MORe's network building

Date:
23.09.2011

Enum Constant Summary
BETA
          The probability of an edge being rewired randomly; the proportion of randomly rewired edges in a graph.
CONSIDER_SOURCES
          Regarding the SmallWorldNetworkBuilder one must pay attention because of the network direction.
K
          Initial degree that is used to build to regular network (local neighbourhood size) to start from.
 
Method Summary
 Object getDefaultValue()
           
 Class<?> getType()
           
static MNetBuildWsPa valueOf(String name)
          Returns the enum constant of this type with the specified name.
static MNetBuildWsPa[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.cesr.parma.core.PmParameterDefinition
getDeclaringClass
 

Enum Constant Detail

BETA

public static final MNetBuildWsPa BETA
The probability of an edge being rewired randomly; the proportion of randomly rewired edges in a graph. Range: (0,1); Default: 0.1.


K

public static final MNetBuildWsPa K
Initial degree that is used to build to regular network (local neighbourhood size) to start from. Must be an even number. Default: 4. If BUILD_WSSM_CONSIDER_SOURCES is TRUE, this value is considered as in-degree!


CONSIDER_SOURCES

public static final MNetBuildWsPa CONSIDER_SOURCES
Regarding the SmallWorldNetworkBuilder one must pay attention because of the network direction. Generally, the small world algorithm considers given k and beta values for the source of a direction. However, in some models we consider the influencer as source and seek to build the network according to the influenced' properties. In this case, set this parameter to FALSE.

Method Detail

values

public static MNetBuildWsPa[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MNetBuildWsPa c : MNetBuildWsPa.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MNetBuildWsPa valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getType

public Class<?> getType()
Specified by:
getType in interface de.cesr.parma.core.PmParameterDefinition
See Also:
PmParameterDefinition.getType()

getDefaultValue

public Object getDefaultValue()
Specified by:
getDefaultValue in interface de.cesr.parma.core.PmParameterDefinition
See Also:
PmParameterDefinition.getDefaultValue()