Package org.jruby.ext.set

Class RubySet

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.set.RubySet

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, Iterable, Collection, Set, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

RubySortedSet

public class RubySet
extends RubyObject
implements Set

Native implementation of Ruby's Set (set.rb replacement).

Author:

kares

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RubySet.DivideTSortHash

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RubySet(Ruby runtime, RubyClass klass)

Method Summary

Modifier and Type	Method	Description
boolean	add(Object element)
RubySet	add(ThreadContext context, IRubyObject obj)	Adds the given object to the set and returns self.
IRubyObject	add_p(ThreadContext context, IRubyObject obj)	Adds the given object to the set and returns self.
boolean	addAll(Collection coll)
protected void	addImpl(Ruby runtime, IRubyObject obj)	Deprecated.
protected void	addImpl(ThreadContext context, IRubyObject obj)
protected void	addImplSet(ThreadContext context, RubySet set)
IRubyObject	classify(ThreadContext context, Block block)
void	clear()
void	clear(ThreadContext context)
protected void	clearImpl()	Deprecated.
protected void	clearImpl(ThreadContext context)
IRubyObject	collect_bang(ThreadContext context, Block block)
IRubyObject	compare_by_identity(ThreadContext context)
IRubyObject	compare_by_identity_p(ThreadContext context)
boolean	contains(Object o)
boolean	containsAll(Collection coll)
static RubySet	create(ThreadContext context, IRubyObject self, IRubyObject... ary)	Creates a new set containing the given objects.
IRubyObject	delete(ThreadContext context, IRubyObject obj)
IRubyObject	delete_if(ThreadContext context, Block block)
IRubyObject	delete_p(ThreadContext context, IRubyObject obj)	Deletes the given object from the set and returns self.
protected boolean	deleteImpl(IRubyObject obj)
protected void	deleteImplIterator(IRubyObject obj, Iterator it)
IRubyObject	disjoint_p(ThreadContext context, IRubyObject setArg)	Returns true if the set and the given set have no element in common.
IRubyObject	divide(ThreadContext context, Block block)	Divides the set into a set of subsets according to the commonality defined by the given block.
IRubyObject	each(ThreadContext context, Block block)
protected final Set<IRubyObject>	elements()
protected Set<IRubyObject>	elementsOrdered()
IRubyObject	empty_p(ThreadContext context)
boolean	eql(IRubyObject otherArg)	method used for Hash key comparison (specialized for String, Symbol and Fixnum)
RubySet	flatten(ThreadContext context)
IRubyObject	flatten_bang(ThreadContext context)
RubySet	flatten_merge(ThreadContext context, IRubyObject set)
IRubyObject	freeze(ThreadContext context)
RubyFixnum	hash(ThreadContext context)	Will return the hash code of this object.
RubyBoolean	include_p(ThreadContext context, IRubyObject obj)	Returns true if the set contains the given object.
IRubyObject	initialize(ThreadContext context, Block block)	initialize(enum = nil, &block)
protected IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	initialize(ThreadContext context, IRubyObject enume, Block block)	initialize(enum = nil, &block)
IRubyObject	initialize_clone(ThreadContext context, IRubyObject[] args)
IRubyObject	initialize_dup(ThreadContext context, IRubyObject orig)
RubyString	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
IRubyObject	instance_variable_set(IRubyObject name, IRubyObject value)	rb_obj_ivar_set call-seq: obj.instance_variable_set(symbol, obj) => obj Sets the instance variable names by symbol to object, thereby frustrating the efforts of the class's author to attempt to provide proper encapsulation.
boolean	intersect(RubySet set)
IRubyObject	intersect_p(ThreadContext context, IRubyObject setArg)	Returns true if the set and the given set have at least one element in common.
boolean	isEmpty()
Iterator<Object>	iterator()
IRubyObject	join(ThreadContext context)
IRubyObject	join(ThreadContext context, IRubyObject sep)
IRubyObject	keep_if(ThreadContext context, Block block)
IRubyObject	length(ThreadContext context)
protected final void	modifyCheck(Ruby runtime)	Deprecated.
protected final void	modifyCheck(ThreadContext context)
static RubySet	newSet(Ruby runtime)	Construct a new Set.
static RubySet	newSet(Ruby runtime, RubyClass metaclass)	Construct a new Set.
IRubyObject	op_and(ThreadContext context, IRubyObject enume)	Returns a new set built by merging the set and the elements of the given enumerable object.
IRubyObject	op_cmp(ThreadContext context, IRubyObject other)
IRubyObject	op_diff(ThreadContext context, IRubyObject enume)	Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.
IRubyObject	op_eql(ThreadContext context, IRubyObject other)
IRubyObject	op_equal(ThreadContext context, IRubyObject other)	rb_obj_equal Will by default use identity equality to compare objects.
IRubyObject	op_or(ThreadContext context, IRubyObject enume)	Returns a new set built by merging the set and the elements of the given enumerable object.
IRubyObject	op_xor(ThreadContext context, IRubyObject enume)	Returns a new set containing elements exclusive between the set and the given enumerable object.
IRubyObject	proper_subset_p(ThreadContext context, IRubyObject setArg)
IRubyObject	proper_superset_p(ThreadContext context, IRubyObject setArg)
Iterator<IRubyObject>	rawIterator()
IRubyObject	rb_clear(ThreadContext context)
RubySet	rb_merge(ThreadContext context, IRubyObject enume)
RubySet	rb_merge(ThreadContext context, IRubyObject... args)	Merges the elements of the given enumerable object to the set and returns self.
IRubyObject	reject_bang(ThreadContext context, Block block)
boolean	remove(Object element)
boolean	removeAll(Collection coll)
RubySet	replace(ThreadContext context, IRubyObject enume)	Replaces the contents of the set with the contents of the given enumerable object and returns self.
IRubyObject	reset(ThreadContext context)
boolean	retainAll(Collection coll)
IRubyObject	select_bang(ThreadContext context, Block block)
int	size()
IRubyObject	subset_p(ThreadContext context, IRubyObject setArg)
IRubyObject	subtract(ThreadContext context, IRubyObject enume)	Deletes every element that appears in the given enumerable object and returns self.
IRubyObject	superset_p(ThreadContext context, IRubyObject setArg)
IRubyObject	taint(ThreadContext context)	Deprecated.
RubyArray	to_a(ThreadContext context)	Converts the set to an array.
RubySet	to_set(ThreadContext context, Block block)
RubySet	to_set(ThreadContext context, IRubyObject[] args, Block block)
Object[]	toArray()
Object[]	toArray(Object[] ary)
IRubyObject	untaint(ThreadContext context)	Deprecated.

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, to_s, toJava, trust, type, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

checkStringType19, dup, marshalLiveVariables

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Details

RubySet

protected RubySet(Ruby runtime,
 RubyClass klass)

Method Details

newSet

public static RubySet newSet(Ruby runtime)

Construct a new Set. The Set class will be retrieved from the global namespace.

Parameters:

runtime - the current runtime

Returns:

a new Set

newSet

public static RubySet newSet(Ruby runtime,
 RubyClass metaclass)

Construct a new Set.

Parameters:

runtime - the current runtime

metaclass - the class to assign to the new set

Returns:

a new Set

create

public static RubySet create(ThreadContext context,
 IRubyObject self,
 IRubyObject... ary)

Creates a new set containing the given objects.

initialize

public IRubyObject initialize(ThreadContext context,
 Block block)

initialize(enum = nil, &block)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject enume,
 Block block)

initialize(enum = nil, &block)

initialize

protected IRubyObject initialize(ThreadContext context,
 IRubyObject[] args,
 Block block)

instance_variable_set

public IRubyObject instance_variable_set(IRubyObject name,
 IRubyObject value)

Description copied from class: RubyBasicObject

rb_obj_ivar_set call-seq: obj.instance_variable_set(symbol, obj) => obj Sets the instance variable names by symbol to object, thereby frustrating the efforts of the class's author to attempt to provide proper encapsulation. The variable did not have to exist prior to this call. class Fred def initialize(p1, p2) @a, @b = p1, p2 end end fred = Fred.new('cat', 99) fred.instance_variable_set(:@a, 'dog') #=> "dog" fred.instance_variable_set(:@c, 'cat') #=> "cat" fred.inspect #=> "#<Fred:0x401b3da8 @a=\"dog\", @b=99, @c=\"cat\">"

Overrides:

instance_variable_set in class RubyBasicObject

Parameters:

name - of ivar

value - to set

Returns:

value of old set ivar

initialize_dup

public IRubyObject initialize_dup(ThreadContext context,
 IRubyObject orig)

initialize_clone

public IRubyObject initialize_clone(ThreadContext context,
 IRubyObject[] args)

freeze

public IRubyObject freeze(ThreadContext context)

Overrides:

freeze in class RubyBasicObject

length

public IRubyObject length(ThreadContext context)

empty_p

public IRubyObject empty_p(ThreadContext context)

rb_clear

public IRubyObject rb_clear(ThreadContext context)

clearImpl

@Deprecated(since="10.0")
protected void clearImpl()

Deprecated.

clearImpl

protected void clearImpl(ThreadContext context)

replace

public RubySet replace(ThreadContext context,
 IRubyObject enume)

Replaces the contents of the set with the contents of the given enumerable object and returns self.

to_a

public RubyArray to_a(ThreadContext context)

Converts the set to an array. The order of elements is uncertain.

Overrides:

to_a in class RubyBasicObject

to_set

public RubySet to_set(ThreadContext context,
 Block block)

to_set

public RubySet to_set(ThreadContext context,
 IRubyObject[] args,
 Block block)

compare_by_identity

public IRubyObject compare_by_identity(ThreadContext context)

compare_by_identity_p

public IRubyObject compare_by_identity_p(ThreadContext context)

flatten_merge

public RubySet flatten_merge(ThreadContext context,
 IRubyObject set)

flatten

public RubySet flatten(ThreadContext context)

flatten_bang

public IRubyObject flatten_bang(ThreadContext context)

include_p

public RubyBoolean include_p(ThreadContext context,
 IRubyObject obj)

Returns true if the set contains the given object.

superset_p

public IRubyObject superset_p(ThreadContext context,
 IRubyObject setArg)

proper_superset_p

public IRubyObject proper_superset_p(ThreadContext context,
 IRubyObject setArg)

subset_p

public IRubyObject subset_p(ThreadContext context,
 IRubyObject setArg)

proper_subset_p

public IRubyObject proper_subset_p(ThreadContext context,
 IRubyObject setArg)

intersect_p

public IRubyObject intersect_p(ThreadContext context,
 IRubyObject setArg)

Returns true if the set and the given set have at least one element in common.

intersect

public boolean intersect(RubySet set)

disjoint_p

public IRubyObject disjoint_p(ThreadContext context,
 IRubyObject setArg)

Returns true if the set and the given set have no element in common. This method is the opposite of +intersect?+.

each

public IRubyObject each(ThreadContext context,
 Block block)

add

public RubySet add(ThreadContext context,
 IRubyObject obj)

Adds the given object to the set and returns self.

addImpl

@Deprecated(since="10.0")
protected void addImpl(Ruby runtime,
 IRubyObject obj)

Deprecated.

addImpl

protected void addImpl(ThreadContext context,
 IRubyObject obj)

addImplSet

protected void addImplSet(ThreadContext context,
 RubySet set)

add_p

public IRubyObject add_p(ThreadContext context,
 IRubyObject obj)

Adds the given object to the set and returns self. If the object is already in the set, returns nil.

delete

public IRubyObject delete(ThreadContext context,
 IRubyObject obj)

deleteImpl

protected boolean deleteImpl(IRubyObject obj)

deleteImplIterator

protected void deleteImplIterator(IRubyObject obj,
 Iterator it)

delete_p

public IRubyObject delete_p(ThreadContext context,
 IRubyObject obj)

Deletes the given object from the set and returns self. If the object is not in the set, returns nil.

delete_if

public IRubyObject delete_if(ThreadContext context,
 Block block)

keep_if

public IRubyObject keep_if(ThreadContext context,
 Block block)

collect_bang

public IRubyObject collect_bang(ThreadContext context,
 Block block)

reject_bang

public IRubyObject reject_bang(ThreadContext context,
 Block block)

select_bang

public IRubyObject select_bang(ThreadContext context,
 Block block)

rb_merge

public RubySet rb_merge(ThreadContext context,
 IRubyObject enume)

rb_merge

public RubySet rb_merge(ThreadContext context,
 IRubyObject... args)

Merges the elements of the given enumerable object to the set and returns self.

subtract

public IRubyObject subtract(ThreadContext context,
 IRubyObject enume)

Deletes every element that appears in the given enumerable object and returns self.

op_or

public IRubyObject op_or(ThreadContext context,
 IRubyObject enume)

Returns a new set built by merging the set and the elements of the given enumerable object.

op_diff

public IRubyObject op_diff(ThreadContext context,
 IRubyObject enume)

Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.

op_and

public IRubyObject op_and(ThreadContext context,
 IRubyObject enume)

Returns a new set built by merging the set and the elements of the given enumerable object.

op_xor

public IRubyObject op_xor(ThreadContext context,
 IRubyObject enume)

Returns a new set containing elements exclusive between the set and the given enumerable object. `(set ^ enum)` is equivalent to `((set | enum) - (set & enum))`.

op_equal

public IRubyObject op_equal(ThreadContext context,
 IRubyObject other)

Description copied from class: RubyBasicObject

rb_obj_equal Will by default use identity equality to compare objects. This follows the Ruby semantics. The name of this method doesn't follow the convention because hierarchy problems

Specified by:

op_equal in interface IRubyObject

Overrides:

op_equal in class RubyBasicObject

reset

public IRubyObject reset(ThreadContext context)

op_eql

public IRubyObject op_eql(ThreadContext context,
 IRubyObject other)

eql

public boolean eql(IRubyObject otherArg)

Description copied from class: RubyBasicObject

method used for Hash key comparison (specialized for String, Symbol and Fixnum)

Specified by:

eql in interface IRubyObject

Overrides:

eql in class RubyBasicObject

Returns:

Will by default just call the Ruby method "eql?"

hash

public RubyFixnum hash(ThreadContext context)

Description copied from class: RubyBasicObject

Will return the hash code of this object. In comparison to MRI, this method will use the Java identity hash code instead of using rb_obj_id, since the usage of id in JRuby will incur the cost of some. ObjectSpace maintenance.

Overrides:

hash in class RubyBasicObject

Parameters:

context - the current thread context

Returns:

the hash value

classify

public IRubyObject classify(ThreadContext context,
 Block block)

divide

public IRubyObject divide(ThreadContext context,
 Block block)

Divides the set into a set of subsets according to the commonality defined by the given block. If the arity of the block is 2, elements o1 and o2 are in common if block.call(o1, o2) is true. Otherwise, elements o1 and o2 are in common if block.call(o1) == block.call(o2). e.g.: require 'set' numbers = Set[1, 3, 4, 6, 9, 10, 11] set = numbers.divide { |i,j| (i - j).abs == 1 } p set # => #<Set: {#<Set: {1}>, # #<Set: {11, 9, 10}>, # #<Set: {3, 4}>, # #<Set: {6}>}>

op_cmp

public IRubyObject op_cmp(ThreadContext context,
 IRubyObject other)

Overrides:

op_cmp in class RubyBasicObject

join

public IRubyObject join(ThreadContext context,
 IRubyObject sep)

join

public IRubyObject join(ThreadContext context)

inspect

public RubyString inspect(ThreadContext context)

Description copied from class: RubyBasicObject

Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyBasicObject

elements

protected final Set<IRubyObject> elements()

elementsOrdered

protected Set<IRubyObject> elementsOrdered()

modifyCheck

@Deprecated
protected final void modifyCheck(Ruby runtime)

Deprecated.

modifyCheck

protected final void modifyCheck(ThreadContext context)

size

public int size()

Specified by:

size in interface Collection

Specified by:

size in interface Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface Set

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface Set

clear

public void clear(ThreadContext context)

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection

Specified by:

contains in interface Set

rawIterator

public Iterator<IRubyObject> rawIterator()

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Collection

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Set

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

toArray

public Object[] toArray(Object[] ary)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface Set

add

public boolean add(Object element)

Specified by:

add in interface Collection

Specified by:

add in interface Set

remove

public boolean remove(Object element)

Specified by:

remove in interface Collection

Specified by:

remove in interface Set

containsAll

public boolean containsAll(Collection coll)

Specified by:

containsAll in interface Collection

Specified by:

containsAll in interface Set

addAll

public boolean addAll(Collection coll)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface Set

retainAll

public boolean retainAll(Collection coll)

Specified by:

retainAll in interface Collection

Specified by:

retainAll in interface Set

removeAll

public boolean removeAll(Collection coll)

Specified by:

removeAll in interface Collection

Specified by:

removeAll in interface Set

taint

@Deprecated
public IRubyObject taint(ThreadContext context)

Deprecated.

Overrides:

taint in class RubyBasicObject

untaint

@Deprecated
public IRubyObject untaint(ThreadContext context)

Deprecated.

Overrides:

untaint in class RubyBasicObject