Metric-HIS.VOCF

HIS VOCF metric: Language scope (vocabulary frequency)

Required inputs: RFG

The language scope is an indicator of the cost of maintaining/changing functions.

VOCF = (N1 + N2) / (n1 + n2), where

• n1 = Number of different operators
• N1 = Sum of all Operators
• n2 = Number of different Operands
• N2 = Sum of all Operands

For more information on what is considered an operator please refer to the documentation (Project Configuration / Language Schema / Language Representation for C / Metrics / Halstead metrics).

Possible Messages

This rule has no predefined messages.

Options

• This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity

• This rule shares the following common metric options: base_view_name, excluded_node_types, hierarchy_edge_name, hierarchy_view_name, propagate, report_all_values, report_propagated_values

• The following places define options that affect this rule: Analysis-GlobalOptions

alias_name

alias_name : str = 'Metric.HIS.VOCF'

Name under which the metric will be reported. In the RFG, a metric with this value is created, too (copied from original metric).

 

display_name

display_name : str | None = 'HIS VOCF'

Description of the metric shown in the dashboard. If None, rfg_metric_name is used.

 

max_value

max_value : float | None = 4.0

Maximum allowed value. None if unlimited.

 

min_value

min_value : float | None = 1.0

Minimum allowed value. None if unlimited.

 

rfg_metric_name

rfg_metric_name

Type: OriginalMetrics

Default: 'Metric.Halstead.Vocabulary_Frequency'

Name of the node attribute storing the metric value in the RFG. The name of the RFG node attribute of the original metric.

 

Option Types

These types are used by options listed above:

OriginalMetrics

An enumeration.

 

• Metric.Halstead.Vocabulary_Frequency