org.jruby.ext.set

Class RubySet

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.set.RubySet

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, java.lang.Iterable, java.util.Collection, java.util.Set, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

RubySortedSet

public class RubySet
extends RubyObject
implements java.util.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 and Description
static 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, UNTRUST_F, 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 and Description
protected	RubySet(Ruby runtime, RubyClass klass)

Method Summary

Modifier and Type	Method and Description
IRubyObject	add_p(ThreadContext context, IRubyObject obj) Adds the given object to the set and returns self.
boolean	add(java.lang.Object element)
RubySet	add(ThreadContext context, IRubyObject obj) Adds the given object to the set and returns self.
boolean	addAll(java.util.Collection coll)
protected void	addImpl(Ruby runtime, IRubyObject obj)
protected void	addImplSet(ThreadContext context, RubySet set)
IRubyObject	classify(ThreadContext context, Block block)
void	clear()
protected void	clearImpl()
IRubyObject	collect_bang(ThreadContext context, Block block)
IRubyObject	compare_by_identity_p(ThreadContext context)
IRubyObject	compare_by_identity(ThreadContext context)
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection coll)
static RubySet	create(ThreadContext context, IRubyObject self, IRubyObject... ary) Creates a new set containing the given objects.
IRubyObject	delete_if(ThreadContext context, Block block)
IRubyObject	delete_p(ThreadContext context, IRubyObject obj) Deletes the given object from the set and returns self.
IRubyObject	delete(ThreadContext context, IRubyObject obj)
protected boolean	deleteImpl(IRubyObject obj)
protected void	deleteImplIterator(IRubyObject obj, java.util.Iterator it)
IRubyObject	disjoint_p(ThreadContext context, IRubyObject set) 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 java.util.Set<IRubyObject>	elements()
protected java.util.Set<IRubyObject>	elementsOrdered()
IRubyObject	empty_p(ThreadContext context)
boolean	eql(IRubyObject other) method used for Hash key comparison (specialized for String, Symbol and Fixnum) Will by default just call the Ruby method "eql?"
IRubyObject	flatten_bang(ThreadContext context)
RubySet	flatten_merge(ThreadContext context, IRubyObject set)
RubySet	flatten(ThreadContext context)
IRubyObject	freeze(ThreadContext context) rb_obj_freeze call-seq: obj.freeze => obj Prevents further modifications to obj.
RubyFixnum	hash() rb_obj_id 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_clone(ThreadContext context, IRubyObject orig)
IRubyObject	initialize_dup(ThreadContext context, IRubyObject orig)
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	inspect() rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
RubyString	inspect(ThreadContext context)
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.
IRubyObject	intersect_p(ThreadContext context, IRubyObject set) Returns true if the set and the given set have at least one element in common.
boolean	intersect(RubySet set)
boolean	isEmpty()
java.util.Iterator<java.lang.Object>	iterator()
IRubyObject	keep_if(ThreadContext context, Block block)
IRubyObject	length(ThreadContext context)
protected void	modifyCheck(Ruby runtime)
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_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 set)
IRubyObject	proper_superset_p(ThreadContext context, IRubyObject set)
java.util.Iterator<IRubyObject>	rawIterator()
IRubyObject	rb_clear(ThreadContext context)
RubySet	rb_merge(ThreadContext context, IRubyObject enume) Merges the elements of the given enumerable object to the set and returns self.
IRubyObject	reject_bang(ThreadContext context, Block block)
boolean	remove(java.lang.Object element)
boolean	removeAll(java.util.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(java.util.Collection coll)
IRubyObject	select_bang(ThreadContext context, Block block)
int	size()
IRubyObject	subset_p(ThreadContext context, IRubyObject set)
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 set)
IRubyObject	taint(ThreadContext context) rb_obj_taint call-seq: obj.taint -> obj Marks obj as tainted---if the $SAFE level is set appropriately, many method calls which might alter the running programs environment will refuse to accept tainted strings.
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)
java.lang.Object[]	toArray()
java.lang.Object[]	toArray(java.lang.Object[] ary)
IRubyObject	untaint(ThreadContext context) rb_obj_untaint call-seq: obj.untaint => obj Removes the taint from obj.

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql_p, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, toJava, trust, type_deprecated, 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, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

array

Constructor Detail

RubySet

protected RubySet(Ruby runtime,
                  RubyClass klass)

Method Detail

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)

Overrides:

instance_variable_set in class RubyBasicObject

initialize_dup

public IRubyObject initialize_dup(ThreadContext context,
                                  IRubyObject orig)

initialize_clone

public IRubyObject initialize_clone(ThreadContext context,
                                    IRubyObject orig)

freeze

public IRubyObject freeze(ThreadContext context)

Description copied from class: RubyBasicObject

rb_obj_freeze call-seq: obj.freeze => obj Prevents further modifications to obj. A TypeError will be raised if modification is attempted. There is no way to unfreeze a frozen object. See also Object#frozen?. a = [ "a", "b", "c" ] a.freeze a << "z" produces: prog.rb:3:in `<<': can't modify frozen array (TypeError) from prog.rb:3

Overrides:

freeze in class RubyBasicObject

taint

public IRubyObject taint(ThreadContext context)

Description copied from class: RubyBasicObject

rb_obj_taint call-seq: obj.taint -> obj Marks obj as tainted---if the $SAFE level is set appropriately, many method calls which might alter the running programs environment will refuse to accept tainted strings.

Overrides:

taint in class RubyBasicObject

untaint

public IRubyObject untaint(ThreadContext context)

Description copied from class: RubyBasicObject

rb_obj_untaint call-seq: obj.untaint => obj Removes the taint from obj. Only callable in if more secure than 3.

Overrides:

untaint 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

protected void clearImpl()

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 set)

proper_superset_p

public IRubyObject proper_superset_p(ThreadContext context,
                                     IRubyObject set)

subset_p

public IRubyObject subset_p(ThreadContext context,
                            IRubyObject set)

proper_subset_p

public IRubyObject proper_subset_p(ThreadContext context,
                                   IRubyObject set)

intersect_p

public IRubyObject intersect_p(ThreadContext context,
                               IRubyObject set)

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 set)

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

protected void addImpl(Ruby runtime,
                       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,
                                  java.util.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)

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 other)

Description copied from class: RubyBasicObject

method used for Hash key comparison (specialized for String, Symbol and Fixnum) Will by default just call the Ruby method "eql?"

Specified by:

eql in interface IRubyObject

Overrides:

eql in class RubyBasicObject

hash

public RubyFixnum hash()

Description copied from class: RubyBasicObject

rb_obj_id 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

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 # => #, # #, # #, # #}>

inspect

public final IRubyObject inspect()

Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string 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

Returns:

String

inspect

public RubyString inspect(ThreadContext context)

elements

protected final java.util.Set<IRubyObject> elements()

elementsOrdered

protected java.util.Set<IRubyObject> elementsOrdered()

modifyCheck

protected final void modifyCheck(Ruby runtime)

size

public int size()

Specified by:

size in interface java.util.Collection

Specified by:

size in interface java.util.Set

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection

Specified by:

isEmpty in interface java.util.Set

clear

public void clear()

Specified by:

clear in interface java.util.Collection

Specified by:

clear in interface java.util.Set

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection

Specified by:

contains in interface java.util.Set

rawIterator

public java.util.Iterator<IRubyObject> rawIterator()

iterator

public java.util.Iterator<java.lang.Object> iterator()

Specified by:

iterator in interface java.lang.Iterable

Specified by:

iterator in interface java.util.Collection

Specified by:

iterator in interface java.util.Set

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

toArray

public java.lang.Object[] toArray(java.lang.Object[] ary)

Specified by:

toArray in interface java.util.Collection

Specified by:

toArray in interface java.util.Set

add

public boolean add(java.lang.Object element)

Specified by:

add in interface java.util.Collection

Specified by:

add in interface java.util.Set

remove

public boolean remove(java.lang.Object element)

Specified by:

remove in interface java.util.Collection

Specified by:

remove in interface java.util.Set

containsAll

public boolean containsAll(java.util.Collection coll)

Specified by:

containsAll in interface java.util.Collection

Specified by:

containsAll in interface java.util.Set

addAll

public boolean addAll(java.util.Collection coll)

Specified by:

addAll in interface java.util.Collection

Specified by:

addAll in interface java.util.Set

retainAll

public boolean retainAll(java.util.Collection coll)

Specified by:

retainAll in interface java.util.Collection

Specified by:

retainAll in interface java.util.Set

removeAll

public boolean removeAll(java.util.Collection coll)

Specified by:

removeAll in interface java.util.Collection

Specified by:

removeAll in interface java.util.Set