Typing
These types and helper functions available in pf.typing can be used to annotate Parametric Components and Models to improve documentation by adding metaddata with constraints, units, etc.
PositiveInt
Section titled “PositiveInt”NonNegativeInt
Section titled “NonNegativeInt”NegativeInt
Section titled “NegativeInt”NonPositiveInt
Section titled “NonPositiveInt”PositiveFloat
Section titled “PositiveFloat”NonNegativeFloat
Section titled “NonNegativeFloat”NegativeFloat
Section titled “NegativeFloat”NonPositiveFloat
Section titled “NonPositiveFloat”Fraction
Section titled “Fraction”Coordinate
Section titled “Coordinate”Dimension
Section titled “Dimension”PositiveDimension
Section titled “PositiveDimension”Coordinate2D
Section titled “Coordinate2D”Dimension2D
Section titled “Dimension2D”PositiveDimension2D
Section titled “PositiveDimension2D”Frequency
Section titled “Frequency”TimeDelay
Section titled “TimeDelay”Velocity
Section titled “Velocity”Temperature
Section titled “Temperature”Voltage
Section titled “Voltage”Impedance
Section titled “Impedance”Resistance
Section titled “Resistance”Inductance
Section titled “Inductance”Capacitance
Section titled “Capacitance”Power_dBm
Section titled “Power_dBm”FieldAmplitude
Section titled “FieldAmplitude”ComplexFieldAmplitude
Section titled “ComplexFieldAmplitude”PropagationLoss
Section titled “PropagationLoss”Dispersion
Section titled “Dispersion”DispersionSlope
Section titled “DispersionSlope”Medium
Section titled “Medium”Helper functions
Section titled “Helper functions”photonforge.typing.annotateAnnotate a type with metadata.photonforge.typing.kwargs_forType that represents keyword arguments for a function or class.photonforge.typing.arrayType for arrays with specified number of dimensions.photonforge.typing.expressionType forExpressionwith a minimal number of values.