agi.foundation.communications.antennas

(agi.foundation.communications-2025r1.jar)

Class WeightedDirection

java.lang.Object

agi.foundation.communications.antennas.WeightedDirection

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class WeightedDirection
extends Object
implements ImmutableValueType

Type which associates a direction, in the form of a UnitCartesian, with an optional weighting metric.

The weighting metric can be used by the MinimumVarianceDistortionlessResponseBeamformer when determining the covariance matrix used when computing the complex element weights. The complex elements weights are used to steer nulls in desired directions. For example, if the weighting metric is set to be the received power from a jamming source, the beamformer can prioritize forming nulls in the direction of the jamming source with the largest interference power.

Constructor Summary

Constructors

Constructor and Description
WeightedDirection() Initializes a new instance.
WeightedDirection(UnitCartesian direction) Initializes a new instance.
WeightedDirection(UnitCartesian direction, double weightingMetric) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
UnitCartesian	getDirection() Gets the direction.
double	getWeightingMetric() Gets the weighting metric associated with the direction.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeightedDirection

public WeightedDirection()

Initializes a new instance.

WeightedDirection

public WeightedDirection(@Nonnull
                         UnitCartesian direction)

Initializes a new instance.

The associated weighting metric defaults to a value of 1.0.

Parameters:

direction - The direction.

WeightedDirection

public WeightedDirection(@Nonnull
                         UnitCartesian direction,
                         double weightingMetric)

Initializes a new instance.

Parameters:

direction - The direction.

weightingMetric - The associated weighting metric.

Method Detail

getDirection

@Nonnull
public final UnitCartesian getDirection()

Gets the direction.

getWeightingMetric

public final double getWeightingMetric()

Gets the weighting metric associated with the direction.

The weighting metric can be used by beamformers in order to prioritize directions when computing complex element weights.

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)