Package org.jmol.util

Class Tuple4f

java.lang.Object

org.jmol.util.Tuple4f

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Point4f

public abstract class Tuple4f
extends java.lang.Object
implements java.io.Serializable

A generic 4 element tuple that is represented by single precision floating point x,y,z and w coordinates.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
float	w	The w coordinate.
float	x	The x coordinate.
float	y	The y coordinate.
float	z	The z coordinate.

Constructor Summary

Constructors

Constructor	Description
Tuple4f()	Constructs and initializes a Tuple4f to (0,0,0,0).

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)	Returns true if all of the data members of Object are equal to the corresponding data members in this
int	hashCode()	Returns a hash number based on the data values in this object.
void	scale(float s)	Sets the value of this tuple to the scalar multiplication of itself.
void	set(float x, float y, float z, float w)	Sets the value of this tuple to the specified xyzw coordinates.
java.lang.String	toString()	Returns a string that contains the values of this Tuple4f.

Methods inherited from class java.lang.Object

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

Field Detail

x

public float x

The x coordinate.

y

public float y

The y coordinate.

z

public float z

The z coordinate.

w

public float w

The w coordinate.

Constructor Detail

Tuple4f

public Tuple4f()

Constructs and initializes a Tuple4f to (0,0,0,0).

Method Detail

set

public final void set(float x,
                      float y,
                      float z,
                      float w)

Sets the value of this tuple to the specified xyzw coordinates.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

w - the w coordinate

scale

public final void scale(float s)

Sets the value of this tuple to the scalar multiplication of itself.

Parameters:

s - the scalar value

hashCode

public int hashCode()

Returns a hash number based on the data values in this object. Two different Tuple4f objects with identical data values (ie, returns true for equals(Tuple4f) ) will return the same hash number. Two vectors with different data members may return the same hash value, although this is not likely.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Returns true if all of the data members of Object are equal to the corresponding data members in this

Overrides:

equals in class java.lang.Object

Parameters:

o - the vector with which the comparison is made.

toString

public java.lang.String toString()

Returns a string that contains the values of this Tuple4f. The form is (x,y,z,w).

Overrides:

toString in class java.lang.Object

Returns:

the String representation