xtd::collections::generic::list< type_t, allocator_t > Class Template Reference

Inheritance diagram for xtd::collections::generic::list< type_t, allocator_t >:

Definition

template<class type_t, class allocator_t>
class xtd::collections::generic::list< type_t, allocator_t >

Represents a strongly typed list of objects that can be accessed by index. Provides methods to search, sort, and manipulate lists.

template<class type_t>
class list : public xtd::object, xtd::collections::generic::ilist<type_t>, public xtd::iequatable<xtd::collections::generic::list<type_t>>

Header

#include <xtd/collections/generic/list>

Namespace

xtd::collections::generic

Library

xtd.core

Examples

The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>.

#include <xtd/xtd>
 
// Simple business object. A part_id is used to identify a part
// but the part name be different for the same Id.
class part : public object, public iequatable<part> {
public:
  string part_name;
  int part_id = 0;
  
  part() = default;
  part(const string& name, int id) : part_name {name}, part_id {id} {}
  
  string to_string() const noexcept override {return string::format("ID: {}   Name: {}", part_id, part_name);}
 
  bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));}
  bool equals(const part& other) const noexcept override {return part_id == other.part_id;}
  
  size get_hash_code() const noexcept override {return object::get_hash_code();}
};
 
class example {
public:
  static auto main() -> void {
    auto parts = list<part> {};
    
    console::write_line("\ncapacity: {0}", parts.capacity());
    
    parts.add(part {"crank arm", 1234});
    parts.add(part {"chain ring", 1334});
    parts.add(part {"seat", 1434});
    parts.add(part {"cassette", 1534});
    parts.add(part {"shift lever", 1634});
    
    console::write_line();
    for (auto part : parts)
      console::write_line(part);
 
    console::write_line("\ncapacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// ID: 1234   Name: crank arm
// ID: 1334   Name: chain ring
// ID: 1434   Name: seat
// ID: 1534   Name: cassette
// ID: 1634   Name: shift lever
//
// capacity: 8
// count: 5
//
// trim_excess()
// capacity: 5
// count: 5
//
// clear()
// capacity: 5
// count: 0

The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class of type string. (For an example of a xtd::collections::generic::list <type_t> of complex types, see the xtd::collections::generic::list::contains method.)

The parameterless constructor is used to create a list of strings with the default capacity. The xtd::collections::generic::list::capacity property is displayed and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

The xtd::collections::generic::list::contains method is used to test for the presence of an item in the list, the Insert method is used to insert a new item in the middle of the list, and the contents of the list are displayed again.

The default xtd::collections::generic::list::operator [] is used to retrieve an item, the xtd::collections::generic::list::remove method is used to remove the first instance of the duplicate item added earlier, and the contents are displayed again. The xtd::collections::generic::list::remove method always removes the first instance it encounters.

The xtd::collections::generic::list::trim_excess method is used to reduce the capacity to match the count, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed. If the unused capacity had been less than 10 percent of total capacity, the list would not have been resized.

Finally, the xtd::collections::generic::list::clear method is used to remove all items from the list, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

The xtd::collections::generic::list <type_t> class instanciate as xtd::collections::generic::list::base_type a std::vector with xtd::collections::generic::helpers::allocator instead std::allocator. Use xtd::collections::generic::list::get_base_type() to access the underlying std::vector.

The xtd::collections::generic::list <type_t> class can also be used to manage a dynamic array of bool exactly as other types unlike std::vector with xtd::collections::generic::helpers::allocator instead std::allocator. When the type_tis bool The underlying std::vector uses xtd::byte.

The xtd::collections::generic::list <type_t> class is the generic equivalent of the xtd::collections::array_list class. It implements the xtd::collections::generic::ilist <type_t> generic interface by using an array whose size is dynamically increased as required.

You can add items to a xtd::collections::generic::list <type_t> by using the xtd::collections::generic::list::add or xtd::collections::generic::list::add_range methods.

The xtd::collections::generic::list <type_t> class uses both an equality comparer and an ordering comparer.

• Methods such as xtd::collections::generic::list::contains, xtd::collections::generic::list::index_of, xtd::collections::generic::list::last_index_of, and xtd::collections::generic::list::remove use an equality comparer for the list elements. The default equality comparer for type type_t is determined as follows. If type type_t implements the xtd::iequatable <type_t> generic interface, then the equality comparer is the xtd::iequatable::equals method of that interface; otherwise, if the type_tinherits of the xtd::object class, the default equality comparer is xtd::object::equals. If the type_t does not implement the xtd::iequality <type_t> interface and does not inherit from xtd::object, the type_t must implement the euqality operator : bool operator ==(const type_t& rhs) const noexcept.
• Methods such as xtd::collections::generic::list::binary_search and xtd::collections::generic::list::sort use an ordering comparer for the list elements. The default comparer for type type_t is determined as follows. If type type_t implements the xtd::icomparable <type_t> generic interface, then the default comparer is the xtd::icomaprable::compare_to method of that interface. If the type_t type does not implement the xtd::icomparable <type_t> interface, the type_t type must implement the less than operator : bool operator <(const type_t& rhs) const noexcept.

The xtd::collections::generic::list <type_t> is not guaranteed to be sorted. You must sort the xtd::collections::generic::list <type_t> before performing operations (such as xtd::collections::binary_search) that require the xtd::collections::generic::list <type_t> to be sorted.

Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based.

For an immutable version of the xtd::collections::generic::list <type_t> class, see xtd::collections::immutale::immutable_list <type_t>.

Performance considerations

As xtd::collections::generic::list <type_t> instantiates and uses only the methods of std::vector, the performance of xtd::collections::generic::list <type_t> is practically identical to that of std::vector.

Examples

assert_throws.cpp, assert_throws_any.cpp, assume_does_not_throw.cpp, assume_throws.cpp, assume_throws_any.cpp, collection_assert.cpp, collection_assert_all_items_are_instances_of.cpp, collection_assert_all_items_are_not_null.cpp, collection_assert_all_items_are_unique.cpp, collection_assert_are_equal.cpp, collection_assert_are_equivalent.cpp, collection_assert_are_not_equal.cpp, collection_assert_are_not_equivalent.cpp, collection_assert_contains.cpp, collection_assert_does_not_contain.cpp, collection_assert_is_empty.cpp, collection_assert_is_not_empty.cpp, collection_assert_is_ordered.cpp, collection_assume.cpp, collection_assume_all_items_are_instances_of.cpp, collection_assume_all_items_are_not_null.cpp, collection_assume_all_items_are_unique.cpp, collection_assume_are_equal.cpp, collection_assume_are_equivalent.cpp, collection_assume_are_not_equal.cpp, collection_assume_are_not_equivalent.cpp, collection_assume_contains.cpp, collection_assume_does_not_contain.cpp, collection_assume_is_empty.cpp, collection_assume_is_not_empty.cpp, collection_assume_is_ordered.cpp, collection_valid.cpp, collection_valid_all_items_are_instances_of.cpp, collection_valid_all_items_are_not_null.cpp, collection_valid_all_items_are_unique.cpp, collection_valid_are_equal.cpp, collection_valid_are_equivalent.cpp, collection_valid_are_not_equal.cpp, collection_valid_are_not_equivalent.cpp, collection_valid_contains.cpp, collection_valid_does_not_contain.cpp, collection_valid_is_empty.cpp, collection_valid_is_not_empty.cpp, collection_valid_is_ordered.cpp, valid_does_not_throw.cpp, valid_throws.cpp, and valid_throws_any.cpp.

Public Aliases
using	value_type
	Represents the list value type.
using	allocator_type
	Represents the list allocator type.
using	base_type
	Represents the list base type.
using	const_base_type
	Represents the list base type.
using	size_type
	Represents the list size type (usually xtd::size).
using	difference_type
	Represents the list difference type (usually xtd::ptrdiff).
using	reference
	Represents the reference of list value type.
using	const_reference
	Represents the const reference of list value type.
using	pointer
	Represents the pointer of list value type.
using	const_pointer
	Represents the const pointer of list value type.
using	iterator
	Represents the iterator of list value type.
using	const_iterator
	Represents the const iterator of list value type.
using	reverse_iterator
	Represents the reverse iterator of list value type.
using	const_reverse_iterator
	Represents the const reverse iterator of list value type.
using	read_only_collection
	Represents the read only collection of of list.

Public Fields
static constexpr size_type	npos
	This is a special value equal to the maximum value representable by the type size_type.

Public Constructors
	list () noexcept=default
	Initializes a new instance of the xtd::collections::generic::list class that is empty.
	list (const allocator_type &alloc) noexcept
	Constructs an empty container with the given allocator.
	list (size_type count, const type_t &value, const allocator_type &alloc=allocator_type())
	Constructs the container with specified count copies of elements with specified value.
	list (size_type count, const allocator_type &alloc=allocator_type())
	Constructs the container with specified count default-inserted instances of type_t. No copies are made.
template<class input_iterator_t>
	list (input_iterator_t first, input_iterator_t last, const allocator_type &alloc=allocator_type())
	Constructs the container with the contents of the range [first, last).
	list (const xtd::collections::generic::ienumerable< type_t > &collection, const allocator_type &alloc=allocator_type())
	Initializes a new instance of the xtd::collections::generic::list <type_t> class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied.
	list (const list &list)
	Default copy constructor with specified list.
	list (const base_type &list)
	Copy constructor with specified base type list.
	list (const list &list, const allocator_type &alloc)
	Default copy constructor with specified list, and allocator.
	list (const base_type &list, const allocator_type &alloc)
	Default copy constructor with specified base type list, and allocator.
	list (std::initializer_list< type_t > items, const allocator_type &alloc=allocator_type())
	Constructs the container with the contents of the specified initializer list, and allocator.
	list (list &&other)
	Move constructor with specified list.
	list (base_type &&other)
	Move constructor with specified base type list.
	list (list &&other, const allocator_type &alloc)
	Move constructor with specified list, and allocator.
	list (base_type &&other, const allocator_type &alloc)
	Move constructor with specified base tyoe list, and allocator.

Public Properties
virtual reference	back ()
	Returns a reference to the last element in the container.
virtual const_reference	back () const
	Returns a reference to the last element in the container.
const_iterator	begin () const noexcept override
	Returns an iterator to the first element of the enumerable.
iterator	begin () noexcept override
	Returns an iterator to the first element of the enumerable.
virtual size_type	capacity () const noexcept
	Gets the total number of elements the internal data structure can hold without resizing.
virtual void	capacity (size_type value)
	Sets the total number of elements the internal data structure can hold without resizing.
const_iterator	cbegin () const noexcept override
	Returns an iterator to the first element of the enumerable.
const_iterator	cend () const noexcept override
	Returns an iterator to the element following the last element of the enumerable.
size_type	count () const noexcept override
	Gets the number of elements contained in the xtd::collections::generic::list <type_t>.
virtual const_reverse_iterator	crbegin () const noexcept
	Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().
virtual const_reverse_iterator	crend () const noexcept
	Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.
virtual pointer	data () noexcept
	Returns pointer to the underlying array serving as element storage.
virtual const_pointer	data () const noexcept
	Returns pointer to the underlying array serving as element storage.
virtual bool	empty () const noexcept
	Checks if the container has no elements, i.e. whether xtd::collections::generic::list::begin() == xtd::collections::generic::list::end().
const_iterator	end () const noexcept override
	Returns an iterator to the element following the last element of the enumerable.
iterator	end () noexcept override
	Returns an iterator to the element following the last element of the enumerable.
virtual reference	front ()
	Returns a reference to the first element in the container.
virtual const_reference	front () const
	Returns a reference to the first element in the container.
bool	is_fixed_size () const noexcept override
	Gets a value indicating whether the xtd::collections::generic::list <type_t> has a fixed size.
bool	is_read_only () const noexcept override
	Gets a value indicating whether the xtd::collections::generic::list <type_t> is read-only.
bool	is_synchronized () const noexcept override
	Gets a value indicating whether access to the xtd::collections::generic::list <type_t> is synchronized (thread safe).
virtual const_base_type &	items () const noexcept
	Returns the underlying base type items.
virtual base_type &	items () noexcept
	Returns the underlying base type items.
virtual size_type	max_size () const noexcept
	Returns the maximum number of elements the container is able to hold due to system or library implementation limitations, i.e. std::distance(xtd::collections::generic::list::begin(), xtd::collections::generic::list::end()) for the largest container.
virtual reverse_iterator	rbegin () noexcept
	Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().
virtual const_reverse_iterator	rbegin () const noexcept
	Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().
virtual reverse_iterator	rend () noexcept
	Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.
virtual const_reverse_iterator	rend () const noexcept
	Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.
virtual size_type	size () const noexcept
	Returns the number of elements in the container, i.e. std::distance(xtd::collections::generic::list::begin(), xtd::collections::generic::list::end()).
const xtd::object &	sync_root () const noexcept override
	Gets an object that can be used to synchronize access to the the xtd::collections::generic::list <type_t>.

Public Methods
void	add (const type_t &item) override
	Adds an object to the end of the xtd::collections::generic::list <type_t>.
void	add (type_t &&item)
	Adds an object to the end of the xtd::collections::generic::list <type_t>.
void	add_range (const xtd::collections::generic::ienumerable< type_t > &enumerable)
	Adds copy of elements from the specified collection to the end of the xtd::collections::generic::list <type_t>.
void	add_range (std::initializer_list< type_t > il)
	Adds copy of elements from the specified collection to the end of the xtd::collections::generic::list <type_t>.
read_only_collection	as_read_only () const noexcept
	Returns a read-only xtd::collections::object_model::read_only_collection <type_t> wrapper for the current collection.
void	assign (size_type count, const type_t &value)
	Replaces the contents with count copies of value value.
template<class input_iterator_t>
void	assign (input_iterator_t first, input_iterator_t last)
	Replaces the contents with copies of those in the range [first, last).
virtual void	assign (std::initializer_list< type_t > items)
	Replaces the contents with the elements from the initializer list items.
virtual reference	at (size_type index)
	Returns a reference to the element at specified location pos, with bounds checking.
virtual const_reference	at (size_type index) const
	Returns a reference to the element at specified location pos, with bounds checking.
xtd::size	binary_search (const type_t &item) const
	Searches the entire sorted xtd::collections::generic::list <type_t> for an element using the default comparer and returns the zero-based index of the element.
xtd::size	binary_search (const type_t &item, const xtd::collections::generic::icomparer< type_t > &comparer) const
	Searches the entire sorted xtd::collections::generic::list <type_t> for an element using the specified comparer and returns the zero-based index of the element.
xtd::size	binary_search (xtd::size index, xtd::size count, const type_t &item, const xtd::collections::generic::icomparer< type_t > &comparer) const
	Searches a range of elements in the sorted xtd::collections::generic::list <type_t> for an element using the specified comparer and returns the zero-based index of the element.
void	clear () override
	Removes all elements from the xtd::collections::generic::list <type_t>.
bool	contains (const type_t &value) const noexcept override
	Determines whether an element is in the xtd::colllections::generic::list <type_t>.
template<class output_t>
list< output_t >	convert_all (xtd::converter< output_t, const type_t & > converter) const
	Converts the elements in the current xtd::colllections::generic::list <type_t> to another type, and returns a list containing the converted elements.
virtual void	copy_to (xtd::array< type_t > &array) const
	Copies the entire xtd::collections::generic::list <type_t> to a compatible one-dimensional array.
void	copy_to (xtd::array< type_t > &array, size_type array_index) const override
	Copies the entire xtd::colllections::generic::list <type_t> to a compatible one-dimensional array, starting at the specified index of the target array.
virtual void	copy_to (size_type index, xtd::array< type_t > &array, size_type array_index, size_type count) const
	Copies the entire xtd::collections::generic::list <type_t> to a compatible one-dimensional array, starting at the specified index of the target array.
template<class ... args_t>
iterator	emplace (const_iterator pos, args_t &&... args)
	Inserts a new element into the container directly before pos.
template<class ... args_t>
reference	emplace_back (args_t &&... args)
	Appends a new element to the end of the container. The element is constructed through std::allocator_traits::construct, which typically uses placement-new to construct the element in-place at the location provided by the container. The arguments args... are forwarded to the constructor as std::forward<Args>(args)....
xtd::size	ensure_capacity (xtd::size capacity)
	Ensures that the capacity of this list is at least the specified capacity. If the current capacity is less than capacity, it is increased to at least the specified capacity.
bool	equals (const object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const list &rhs) const noexcept override
virtual size_type	index_of (const type_t &value, size_type index, size_type count) const
	Erases the specified elements from the container.
virtual iterator	insert (const_iterator pos, const type_t &value)
	Inserts elements at the specified location in the container.
virtual iterator	insert (const_iterator pos, type_t &&value)
	Inserts elements at the specified location in the container.
virtual iterator	insert (const_iterator pos, size_type count, const type_t &value)
	Inserts elements at the specified location in the container.
virtual iterator	insert (const_iterator pos, size_type count, type_t &&value)
	Inserts elements at the specified location in the container.
template<class input_iterator_t>
iterator	insert (const_iterator pos, input_iterator_t first, input_iterator_t last)
	Inserts elements at the specified location in the container.
virtual iterator	insert (const_iterator pos, const std::initializer_list< type_t > &items)
	Inserts elements at the specified location in the container.
void	insert (size_type index, const type_t &value) override
	Inserts an element into the xtd::collections::generic::list <type_t> at the specified index.
void	insert (size_type index, type_t &&value)
	Inserts an element into the xtd::collections::generic::list <type_t> at the specified index.
virtual void	insert_range (size_type index, const xtd::collections::generic::ienumerable< type_t > &enumerable)
	Inserts copy of elements from a collection into the xtd::collections::generic::list <type_t> at the specified index.
virtual void	insert_range (size_type index, const std::initializer_list< type_t > &items)
	Inserts copy of elements from a collection into the xtd::collections::generic::list <type_t> at the specified index.
size_type	last_index_of (const type_t &value) const
	Determines the last index of a specific item in the xtd::collections::generic::list <type_t>.
virtual void	resize (size_type count)
	Determines the last index of a specific item in the xtd::collections::generic::list <type_t>.

Public Operators
Copy assignment operator. Replaces the contents with a copy of the contents of other. / / / / Parameters other Another container to use as data source. / Returns This current instance. list& operator =(const list& other) = default; / Move assignment operator. Replaces the contents with those of other using move semantics (i.e. the data in other is moved from other into this container). other is in a valid but unspecified state afterwards. / Parameters other Another base type container to use as data source. / Returns This current instance. list& operator =(list&& other) noexcept { data_->version = std::move(other.data_->version); data_->items = std::move(other.data_->items); return *this; } / Replaces the contents with those identified by initializer list ilist. / Parameters items Initializer list to use as data source / Returns This current instance. list& operator =(std::initializer_list<type_t>& items) { data_->version = 0; data_->items = items; return *this; } / Returns a reference to the element at specified location index. / Parameters index The position of the element to return. / Returns Reference to the requested element. / Exceptions std::out_of_range If `index` is not within the range of the container. const_reference operator [](size_type index) const override {return at(index);} / Returns a reference to the element at specified location index. / Parameters index The position of the element to return. / Returns Reference to the requested element. / Exceptions std::out_of_range If `index` is not within the range of the container.
reference	operator[] (size_type index) override
	operator const base_type & () const noexcept
	Returns a reference to the underlying base type.
	operator base_type & () noexcept
	Returns a reference to the underlying base type.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
virtual bool	equals (const type_t &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

value_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::value_type

Represents the list value type.

allocator_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::allocator_type

Represents the list allocator type.

base_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::base_type

Represents the list base type.

const_base_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::const_base_type

Represents the list base type.

size_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::size_type

Represents the list size type (usually xtd::size).

difference_type

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::difference_type

Represents the list difference type (usually xtd::ptrdiff).

reference

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::reference

Represents the reference of list value type.

const_reference

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::const_reference

Represents the const reference of list value type.

pointer

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::pointer

Represents the pointer of list value type.

const_pointer

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::const_pointer

Represents the const pointer of list value type.

iterator

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::iterator

Represents the iterator of list value type.

const_iterator

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::const_iterator

Represents the const iterator of list value type.

reverse_iterator

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::reverse_iterator

Represents the reverse iterator of list value type.

const_reverse_iterator

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::const_reverse_iterator

Represents the const reverse iterator of list value type.

read_only_collection

template<class type_t, class allocator_t>

using xtd::collections::generic::list< type_t, allocator_t >::read_only_collection

Represents the read only collection of of list.

Constructor & Destructor Documentation

list() [1/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( )

defaultnoexcept

Initializes a new instance of the xtd::collections::generic::list class that is empty.

Examples

The code example adds, inserts, and removes items, showing how the capacity changes as these methods are used.

#include <xtd/xtd>
 
// Simple business object. A part_id is used to identify a part
// but the part name be different for the same Id.
class part : public object, public iequatable<part> {
public:
  string part_name;
  int part_id = 0;
  
  part() = default;
  part(const string& name, int id) : part_name {name}, part_id {id} {}
  
  string to_string() const noexcept override {return string::format("ID: {}   Name: {}", part_id, part_name);}
 
  bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));}
  bool equals(const part& other) const noexcept override {return part_id == other.part_id;}
  
  size get_hash_code() const noexcept override {return object::get_hash_code();}
};
 
class example {
public:
  static auto main() -> void {
    auto parts = list<part> {};
    
    console::write_line("\ncapacity: {0}", parts.capacity());
    
    parts.add(part {"crank arm", 1234});
    parts.add(part {"chain ring", 1334});
    parts.add(part {"seat", 1434});
    parts.add(part {"cassette", 1534});
    parts.add(part {"shift lever", 1634});
    
    console::write_line();
    for (auto part : parts)
      console::write_line(part);
 
    console::write_line("\ncapacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// ID: 1234   Name: crank arm
// ID: 1334   Name: chain ring
// ID: 1434   Name: seat
// ID: 1534   Name: cassette
// ID: 1634   Name: shift lever
//
// capacity: 8
// count: 5
//
// trim_excess()
// capacity: 5
// count: 5
//
// clear()
// capacity: 5
// count: 0

Remarks

The capacity of a xtd::collections::generic::list is the number of elements that the xtd::collections::generic::list can hold. As elements are added to a xtd::collections::generic::list, the capacity is automatically increased as required by reallocating the internal array.

If the size of the collection can be estimated, using the xtd::collections::generic::list (size_type) constructor and specifying the initial capacity eliminates the need to perform a number of resizing operations while adding elements to the xtd::collections::generic::list.

The capacity can be decreased by calling the xtd::collections::generic::list::trim_excess method or by setting the xtd::collections::generic::list::capacity property explicitly. Decreasing the capacity reallocates memory and copies all the elements in the xtd::collections::generic::list.

This constructor is an O(1) operation.

The following code example demonstrates the default constructor of the xtd::collections::generic::list generic class. The default constructor creates a list with the default capacity, as demonstrated by displaying the xtd::collections::generic::list::capacity property.

list() [2/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const allocator_type & alloc )

inlineexplicitnoexcept

Constructs an empty container with the given allocator.

Parameters

alloc

The allocator to use for all memory allocations of this container.

list() [3/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( size_type count, const type_t & value, const allocator_type & alloc = allocator_type() )

inline

Constructs the container with specified count copies of elements with specified value.

Parameters

count	The size of the container.
value	The value to initialize elements of the container with.
alloc	The allocator to use for all memory allocations of this container.

list() [4/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( size_type count, const allocator_type & alloc = allocator_type() )

inlineexplicit

Constructs the container with specified count default-inserted instances of type_t. No copies are made.

Parameters

count	The size of the container.
alloc	The allocator to use for all memory allocations of this container.

list() [5/15]

template<class type_t, class allocator_t>

template<class input_iterator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( input_iterator_t first, input_iterator_t last, const allocator_type & alloc = allocator_type() )

inline

Constructs the container with the contents of the range [first, last).

Parameters

first	The first iterator the range to copy the elements from.
last	The last iterator the range to copy the elements from.
alloc	The allocator to use for all memory allocations of this container.

list() [6/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const xtd::collections::generic::ienumerable< type_t > & collection, const allocator_type & alloc = allocator_type() )

inline

Initializes a new instance of the xtd::collections::generic::list <type_t> class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied.

Parameters

collection	The collection whose elements are copied to the new list.
alloc	The allocator to use for all memory allocations of this container.

Examples

The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

Remarks

The elements are copied onto the xtd::collections::generic::list <type_t> in the same order they are read by the enumerator of the collection.

This constructor is an O(n) operation, where n is the number of elements in collection.

list() [7/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const list< type_t, allocator_t > & list )

inline

Default copy constructor with specified list.

Parameters

list	The xtd::collections::generic::list which elements will be inserted from.

list() [8/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const base_type & list )

inline

Copy constructor with specified base type list.

Parameters

list	The xtd::collections::generic::list::base_type which elements will be inserted from.

list() [9/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const list< type_t, allocator_t > & list, const allocator_type & alloc )

inline

Default copy constructor with specified list, and allocator.

Parameters

list	The xtd::collections::generic::list which elements will be inserted from.
alloc	The allocator to use for all memory allocations of this container.

list() [10/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( const base_type & list, const allocator_type & alloc )

inline

Default copy constructor with specified base type list, and allocator.

Parameters

list	The xtd::collections::generic::list which elements will be inserted from.
alloc	The allocator to use for all memory allocations of this container.

list() [11/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( std::initializer_list< type_t > items, const allocator_type & alloc = allocator_type() )

inline

Constructs the container with the contents of the specified initializer list, and allocator.

Parameters

items	The initializer list to initialize the elements of the container with.
alloc	The allocator to use for all memory allocations of this container.

list() [12/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( list< type_t, allocator_t > && other )

inline

Move constructor with specified list.

Parameters

list	The xtd::collections::generic::list::base_type which elements will be moved from.

list() [13/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( base_type && other )

inline

Move constructor with specified base type list.

Parameters

list	The xtd::collections::generic::list::base_type which elements will be moved from.

list() [14/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( list< type_t, allocator_t > && other, const allocator_type & alloc )

inline

Move constructor with specified list, and allocator.

Parameters

list	The xtd::collections::generic::list::base_type which elements will be moved from.
alloc	The allocator to use for all memory allocations of this container.

list() [15/15]

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::list ( base_type && other, const allocator_type & alloc )

inline

Move constructor with specified base tyoe list, and allocator.

Parameters

list	The xtd::collections::generic::list::base_type which elements will be moved from.
alloc	The allocator to use for all memory allocations of this container.

Member Function Documentation

back() [1/2]

template<class type_t, class allocator_t>

virtual reference xtd::collections::generic::list< type_t, allocator_t >::back ( )

inlinevirtual

Returns a reference to the last element in the container.

Returns

Reference to the first element.

Remarks

Calling front on an empty container causes undefined behavior.

back() [2/2]

template<class type_t, class allocator_t>

virtual const_reference xtd::collections::generic::list< type_t, allocator_t >::back ( ) const

inlinevirtual

Returns a reference to the last element in the container.

Returns

Reference to the first element.

Remarks

Calling front on an empty container causes undefined behavior.

begin() [1/2]

template<class type_t, class allocator_t>

const_iterator xtd::collections::generic::list< type_t, allocator_t >::begin ( ) const

inlineoverridenoexcept

Returns an iterator to the first element of the enumerable.

Returns

Iterator to the first element.

begin() [2/2]

template<class type_t, class allocator_t>

iterator xtd::collections::generic::list< type_t, allocator_t >::begin ( )

inlineoverridenoexcept

Returns an iterator to the first element of the enumerable.

Returns

Iterator to the first element.

capacity() [1/2]

template<class type_t, class allocator_t>

virtual size_type xtd::collections::generic::list< type_t, allocator_t >::capacity ( ) const

inlinevirtualnoexcept

Gets the total number of elements the internal data structure can hold without resizing.

Returns

Capacity of the currently allocated storage. @exceptions xtd::argument_out_of_range_exception xtd::collections::generic::list::capacity is set to a value that is less than xtd::collections::generic::list::count.

Examples

The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>.

#include <xtd/xtd>
 
// Simple business object. A part_id is used to identify a part
// but the part name be different for the same Id.
class part : public object, public iequatable<part> {
public:
  string part_name;
  int part_id = 0;
  
  part() = default;
  part(const string& name, int id) : part_name {name}, part_id {id} {}
  
  string to_string() const noexcept override {return string::format("ID: {}   Name: {}", part_id, part_name);}
 
  bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));}
  bool equals(const part& other) const noexcept override {return part_id == other.part_id;}
  
  size get_hash_code() const noexcept override {return object::get_hash_code();}
};
 
class example {
public:
  static auto main() -> void {
    auto parts = list<part> {};
    
    console::write_line("\ncapacity: {0}", parts.capacity());
    
    parts.add(part {"crank arm", 1234});
    parts.add(part {"chain ring", 1334});
    parts.add(part {"seat", 1434});
    parts.add(part {"cassette", 1534});
    parts.add(part {"shift lever", 1634});
    
    console::write_line();
    for (auto part : parts)
      console::write_line(part);
 
    console::write_line("\ncapacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// ID: 1234   Name: crank arm
// ID: 1334   Name: chain ring
// ID: 1434   Name: seat
// ID: 1534   Name: cassette
// ID: 1634   Name: shift lever
//
// capacity: 8
// count: 5
//
// trim_excess()
// capacity: 5
// count: 5
//
// clear()
// capacity: 5
// count: 0

The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class of type string. (For an example of a xtd::collections::generic::list <type_t> of complex types, see the xtd::collections::generic::list::contains method.)

The parameterless constructor is used to create a list of strings with the default capacity. The xtd::collections::generic::list::capacity property is displayed and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

The xtd::collections::generic::list::contains method is used to test for the presence of an item in the list, the Insert method is used to insert a new item in the middle of the list, and the contents of the list are displayed again.

The default xtd::collections::generic::list::operator [] is used to retrieve an item, the xtd::collections::generic::list::remove method is used to remove the first instance of the duplicate item added earlier, and the contents are displayed again. The xtd::collections::generic::list::remove method always removes the first instance it encounters.

The xtd::collections::generic::list::trim_excess method is used to reduce the capacity to match the count, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed. If the unused capacity had been less than 10 percent of total capacity, the list would not have been resized.

Finally, the xtd::collections::generic::list::clear method is used to remove all items from the list, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

xtd::collections::generic::list::capacity is the number of elements that the xtd::collections::generic::list <type_t> can store before resizing is required, whereas xtd::collections::generic::list::count is the number of elements that are actually in the xtd::collections::generic::list <type_t>.

xtd::collections::generic::list::capacity is always greater than or equal to xtd::collections::generic::list::count. If xtd::collections::generic::list::count exceeds xtd::collections::generic::list::capacity while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements.

If the capacity is significantly larger than the count and you want to reduce the memory used by the xtd::collections::generic::list <type_t>, you can decrease capacity by calling the xtd::collections::generic::list::trim_excess method or by setting the xtd::collections::generic::list::capacity property explicitly to a lower value. When the value of xtd::collections::generic::list::capacity is set explicitly, the internal array is also reallocated to accommodate the specified capacity, and all the elements are copied.

Retrieving the value of this property is an O(1) operation; setting the property is an O(n) operation, where n is the new capacity.

capacity() [2/2]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::capacity ( size_type value )

inlinevirtual

Sets the total number of elements the internal data structure can hold without resizing.

Returns

Capacity of the currently allocated storage. @exceptions xtd::argument_out_of_range_exception xtd::collections::generic::list::capacity is set to a value that is less than xtd::collections::generic::list::count.

Examples

The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>.

#include <xtd/xtd>
 
// Simple business object. A part_id is used to identify a part
// but the part name be different for the same Id.
class part : public object, public iequatable<part> {
public:
  string part_name;
  int part_id = 0;
  
  part() = default;
  part(const string& name, int id) : part_name {name}, part_id {id} {}
  
  string to_string() const noexcept override {return string::format("ID: {}   Name: {}", part_id, part_name);}
 
  bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));}
  bool equals(const part& other) const noexcept override {return part_id == other.part_id;}
  
  size get_hash_code() const noexcept override {return object::get_hash_code();}
};
 
class example {
public:
  static auto main() -> void {
    auto parts = list<part> {};
    
    console::write_line("\ncapacity: {0}", parts.capacity());
    
    parts.add(part {"crank arm", 1234});
    parts.add(part {"chain ring", 1334});
    parts.add(part {"seat", 1434});
    parts.add(part {"cassette", 1534});
    parts.add(part {"shift lever", 1634});
    
    console::write_line();
    for (auto part : parts)
      console::write_line(part);
 
    console::write_line("\ncapacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// ID: 1234   Name: crank arm
// ID: 1334   Name: chain ring
// ID: 1434   Name: seat
// ID: 1534   Name: cassette
// ID: 1634   Name: shift lever
//
// capacity: 8
// count: 5
//
// trim_excess()
// capacity: 5
// count: 5
//
// clear()
// capacity: 5
// count: 0

The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class of type string. (For an example of a xtd::collections::generic::list <type_t> of complex types, see the xtd::collections::generic::list::contains method.)

The parameterless constructor is used to create a list of strings with the default capacity. The xtd::collections::generic::list::capacity property is displayed and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

The xtd::collections::generic::list::contains method is used to test for the presence of an item in the list, the Insert method is used to insert a new item in the middle of the list, and the contents of the list are displayed again.

The default xtd::collections::generic::list::operator [] is used to retrieve an item, the xtd::collections::generic::list::remove method is used to remove the first instance of the duplicate item added earlier, and the contents are displayed again. The xtd::collections::generic::list::remove method always removes the first instance it encounters.

The xtd::collections::generic::list::trim_excess method is used to reduce the capacity to match the count, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed. If the unused capacity had been less than 10 percent of total capacity, the list would not have been resized.

Finally, the xtd::collections::generic::list::clear method is used to remove all items from the list, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

xtd::collections::generic::list::capacity is the number of elements that the xtd::collections::generic::list <type_t> can store before resizing is required, whereas xtd::collections::generic::list::count is the number of elements that are actually in the xtd::collections::generic::list <type_t>.

xtd::collections::generic::list::capacity is always greater than or equal to xtd::collections::generic::list::count. If xtd::collections::generic::list::count exceeds xtd::collections::generic::list::capacity while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements.

If the capacity is significantly larger than the count and you want to reduce the memory used by the xtd::collections::generic::list <type_t>, you can decrease capacity by calling the xtd::collections::generic::list::trim_excess method or by setting the xtd::collections::generic::list::capacity property explicitly to a lower value. When the value of xtd::collections::generic::list::capacity is set explicitly, the internal array is also reallocated to accommodate the specified capacity, and all the elements are copied.

Retrieving the value of this property is an O(1) operation; setting the property is an O(n) operation, where n is the new capacity.

cbegin()

template<class type_t, class allocator_t>

const_iterator xtd::collections::generic::list< type_t, allocator_t >::cbegin ( ) const

inlineoverridenoexcept

Returns an iterator to the first element of the enumerable.

Returns

Iterator to the first element.

cend()

template<class type_t, class allocator_t>

const_iterator xtd::collections::generic::list< type_t, allocator_t >::cend ( ) const

inlineoverridenoexcept

Returns an iterator to the element following the last element of the enumerable.

Returns

Iterator to the element following the last element.

count()

template<class type_t, class allocator_t>

size_type xtd::collections::generic::list< type_t, allocator_t >::count ( ) const

inlineoverridenoexcept

Gets the number of elements contained in the xtd::collections::generic::list <type_t>.

Returns

The number of elements contained in the xtd::collections::generic::list <type_t>.

Examples

The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>.

#include <xtd/xtd>
 
// Simple business object. A part_id is used to identify a part
// but the part name be different for the same Id.
class part : public object, public iequatable<part> {
public:
  string part_name;
  int part_id = 0;
  
  part() = default;
  part(const string& name, int id) : part_name {name}, part_id {id} {}
  
  string to_string() const noexcept override {return string::format("ID: {}   Name: {}", part_id, part_name);}
 
  bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));}
  bool equals(const part& other) const noexcept override {return part_id == other.part_id;}
  
  size get_hash_code() const noexcept override {return object::get_hash_code();}
};
 
class example {
public:
  static auto main() -> void {
    auto parts = list<part> {};
    
    console::write_line("\ncapacity: {0}", parts.capacity());
    
    parts.add(part {"crank arm", 1234});
    parts.add(part {"chain ring", 1334});
    parts.add(part {"seat", 1434});
    parts.add(part {"cassette", 1534});
    parts.add(part {"shift lever", 1634});
    
    console::write_line();
    for (auto part : parts)
      console::write_line(part);
 
    console::write_line("\ncapacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
    
    parts.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", parts.capacity());
    console::write_line("count: {0}", parts.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// ID: 1234   Name: crank arm
// ID: 1334   Name: chain ring
// ID: 1434   Name: seat
// ID: 1534   Name: cassette
// ID: 1634   Name: shift lever
//
// capacity: 8
// count: 5
//
// trim_excess()
// capacity: 5
// count: 5
//
// clear()
// capacity: 5
// count: 0

The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class of type string. (For an example of a xtd::collections::generic::list <type_t> of complex types, see the xtd::collections::generic::list::contains method.)

The parameterless constructor is used to create a list of strings with the default capacity. The xtd::collections::generic::list::capacity property is displayed and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

The xtd::collections::generic::list::contains method is used to test for the presence of an item in the list, the Insert method is used to insert a new item in the middle of the list, and the contents of the list are displayed again.

The default xtd::collections::generic::list::operator [] is used to retrieve an item, the xtd::collections::generic::list::remove method is used to remove the first instance of the duplicate item added earlier, and the contents are displayed again. The xtd::collections::generic::list::remove method always removes the first instance it encounters.

The xtd::collections::generic::list::trim_excess method is used to reduce the capacity to match the count, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed. If the unused capacity had been less than 10 percent of total capacity, the list would not have been resized.

Finally, the xtd::collections::generic::list::clear method is used to remove all items from the list, and the xtd::collections::generic::list::capacity and xtd::collections::generic::list::count properties are displayed.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

xtd::collections::generic::list::capacity is the number of elements that the xtd::collections::generic::list <type_t> can store before resizing is required, whereas xtd::collections::generic::list::count is the number of elements that are actually in the xtd::collections::generic::list <type_t>.

xtd::collections::generic::list::capacity is always greater than or equal to xtd::collections::generic::list::count. If xtd::collections::generic::list::count exceeds xtd::collections::generic::list::capacity while adding elements, the capacity is increased by automatically reallocating the internal array before copying the old elements and adding the new elements.

If the capacity is significantly larger than the count and you want to reduce the memory used by the xtd::collections::generic::list <type_t>, you can decrease capacity by calling the xtd::collections::generic::list::trim_excess method or by setting the xtd::collections::generic::list::capacity property explicitly to a lower value. When the value of xtd::collections::generic::list::capacity is set explicitly, the internal array is also reallocated to accommodate the specified capacity, and all the elements are copied.

Retrieving the value of this property is an O(1) operation; setting the property is an O(n) operation, where n is the new capacity.

crbegin()

template<class type_t, class allocator_t>

virtual const_reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::crbegin ( ) const

inlinevirtualnoexcept

Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().

Returns

Reverse iterator to the first element.

Remarks

If the vector is empty, the returned iterator will be equal to xtd::collections::generic::list::rend().

crend()

template<class type_t, class allocator_t>

virtual const_reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::crend ( ) const

inlinevirtualnoexcept

Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.

Returns

Reverse iterator to the element following the last element.

Remarks

This element acts as a placeholder; attempting to access it results in undefined behavior.

data() [1/2]

template<class type_t, class allocator_t>

virtual pointer xtd::collections::generic::list< type_t, allocator_t >::data ( )

inlinevirtualnoexcept

Returns pointer to the underlying array serving as element storage.

Returns

Pointer to the underlying element storage. For non-empty containers, the returned pointer compares equal to the address of the first element.

Remarks

The pointer is such that range [xtd::collections::generic::list::data(), xtd::collections::generic::list::data() + xtd::collections::generic::list::size()) is always a valid range, even if the container is empty (xtd::collections::generic::list::data() is not dereferenceable in that case).

data() [2/2]

template<class type_t, class allocator_t>

virtual const_pointer xtd::collections::generic::list< type_t, allocator_t >::data ( ) const

inlinevirtualnoexcept

Returns pointer to the underlying array serving as element storage.

Returns

Pointer to the underlying element storage. For non-empty containers, the returned pointer compares equal to the address of the first element.

Remarks

The pointer is such that range [xtd::collections::generic::list::data(), xtd::collections::generic::list::data() + xtd::collections::generic::list::size()) is always a valid range, even if the container is empty (xtd::collections::generic::list::data() is not dereferenceable in that case).

empty()

template<class type_t, class allocator_t>

virtual bool xtd::collections::generic::list< type_t, allocator_t >::empty ( ) const

inlinevirtualnoexcept

Checks if the container has no elements, i.e. whether xtd::collections::generic::list::begin() == xtd::collections::generic::list::end().

Returns

true if the container is empty, false otherwise.

end() [1/2]

template<class type_t, class allocator_t>

const_iterator xtd::collections::generic::list< type_t, allocator_t >::end ( ) const

inlineoverridenoexcept

Returns an iterator to the element following the last element of the enumerable.

Returns

Iterator to the element following the last element.

end() [2/2]

template<class type_t, class allocator_t>

iterator xtd::collections::generic::list< type_t, allocator_t >::end ( )

inlineoverridenoexcept

Returns an iterator to the element following the last element of the enumerable.

Returns

Iterator to the element following the last element.

front() [1/2]

template<class type_t, class allocator_t>

virtual reference xtd::collections::generic::list< type_t, allocator_t >::front ( )

inlinevirtual

Returns a reference to the first element in the container.

Returns

Reference to the first element.

Remarks

Calling front on an empty container causes undefined behavior.

front() [2/2]

template<class type_t, class allocator_t>

virtual const_reference xtd::collections::generic::list< type_t, allocator_t >::front ( ) const

inlinevirtual

Returns a reference to the first element in the container.

Returns

Reference to the first element.

Remarks

Calling front on an empty container causes undefined behavior.

is_fixed_size()

template<class type_t, class allocator_t>

bool xtd::collections::generic::list< type_t, allocator_t >::is_fixed_size ( ) const

inlineoverridenoexcept

Gets a value indicating whether the xtd::collections::generic::list <type_t> has a fixed size.

Returns

true if the xtd::collections::generic::list <type_t> has a fixed size; otherwise, false.

Remarks

A collection with a fixed size does not allow the addition or removal of elements after the collection is created, but it allows the modification of existing elements.

is_read_only()

template<class type_t, class allocator_t>

bool xtd::collections::generic::list< type_t, allocator_t >::is_read_only ( ) const

inlineoverridenoexcept

Gets a value indicating whether the xtd::collections::generic::list <type_t> is read-only.

Returns

true if the xtd::collections::generic::list <type_t> is read-only; otherwise, false.

Remarks

A collection that is read-only does not allow the addition or removal of elements after the collection is created. Note that read-only in this context does not indicate whether individual elements of the collection can be modified, since the xtd::collections::generic::list <type_t> interface only supports addition and removal operations. For example, the xtd::collections::generic::list::is_read_only property of an array that is cast or converted to an xtd::collections::generic::list <type_t> object returns true, even though individual array elements can be modified.

is_synchronized()

template<class type_t, class allocator_t>

bool xtd::collections::generic::list< type_t, allocator_t >::is_synchronized ( ) const

inlineoverridenoexcept

Gets a value indicating whether access to the xtd::collections::generic::list <type_t> is synchronized (thread safe).

Returns

true if access to the xtd::collections::generic::list <type_t> is synchronized (thread safe); otherwise, false.

Remarks

xtd::collections::generic::list::sync_root returns an object, which can be used to synchronize access to the xtd::collections::generic::list <type_t>.

Most collection classes in the xtd::collections namespace also implement a synchronized method, which provides a synchronized wrapper around the underlying collection.

Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

The following code example shows how to lock the collection using the xtd::collections::generic::list::sync_root property during the entire enumeration.

list& my_collection = some_collection;
lock_(my_collection.sync_root()) {
  for (auto item : my_collection) {
    // Insert your code here.
  }
}

items() [1/2]

template<class type_t, class allocator_t>

virtual const_base_type & xtd::collections::generic::list< type_t, allocator_t >::items ( ) const

inlinevirtualnoexcept

Returns the underlying base type items.

Returns

The underlying base type items.

items() [2/2]

template<class type_t, class allocator_t>

virtual base_type & xtd::collections::generic::list< type_t, allocator_t >::items ( )

inlinevirtualnoexcept

Returns the underlying base type items.

Returns

The underlying base type items.

max_size()

template<class type_t, class allocator_t>

virtual size_type xtd::collections::generic::list< type_t, allocator_t >::max_size ( ) const

inlinevirtualnoexcept

Returns the maximum number of elements the container is able to hold due to system or library implementation limitations, i.e. std::distance(xtd::collections::generic::list::begin(), xtd::collections::generic::list::end()) for the largest container.

Returns

Maximum number of elements.

rbegin() [1/2]

template<class type_t, class allocator_t>

virtual reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::rbegin ( )

inlinevirtualnoexcept

Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().

Returns

Reverse iterator to the first element.

Remarks

If the vector is empty, the returned iterator will be equal to xtd::collections::generic::list::rend().

rbegin() [2/2]

template<class type_t, class allocator_t>

virtual const_reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::rbegin ( ) const

inlinevirtualnoexcept

Returns a reverse iterator to the first element of the reversed vector. It corresponds to the last element of the non-reversed vector. If the vector is empty, the returned iterator is equal to xtd::collections::generic::list::rend().

Returns

Reverse iterator to the first element.

Remarks

If the vector is empty, the returned iterator will be equal to xtd::collections::generic::list::rend().

rend() [1/2]

template<class type_t, class allocator_t>

virtual reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::rend ( )

inlinevirtualnoexcept

Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.

Returns

Reverse iterator to the element following the last element.

Remarks

This element acts as a placeholder; attempting to access it results in undefined behavior.

rend() [2/2]

template<class type_t, class allocator_t>

virtual const_reverse_iterator xtd::collections::generic::list< type_t, allocator_t >::rend ( ) const

inlinevirtualnoexcept

Returns a reverse iterator to the element following the last element of the reversed vector. It corresponds to the element preceding the first element of the non-reversed vector. This element acts as a placeholder, attempting to access it results in undefined behavior.

Returns

Reverse iterator to the element following the last element.

Remarks

This element acts as a placeholder; attempting to access it results in undefined behavior.

size()

template<class type_t, class allocator_t>

virtual size_type xtd::collections::generic::list< type_t, allocator_t >::size ( ) const

inlinevirtualnoexcept

Returns the number of elements in the container, i.e. std::distance(xtd::collections::generic::list::begin(), xtd::collections::generic::list::end()).

Returns

The number of elements in the container.

sync_root()

template<class type_t, class allocator_t>

const xtd::object & xtd::collections::generic::list< type_t, allocator_t >::sync_root ( ) const

inlineoverridenoexcept

Gets an object that can be used to synchronize access to the the xtd::collections::generic::list <type_t>.

Returns

An object that can be used to synchronize access to the the xtd::collections::generic::list <type_t>.

Remarks

For collections whose underlying store is not publicly available, the expected implementation is to return the current instance. Note that the pointer to the current instance might not be sufficient for collections that wrap other collections; those should return the underlying collection's sync_root property.

Most collection classes in the xts::.collections namespace also implement a synchronized method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the xtd::collections::generic::list::sync_root property. The synchronizing code must perform operations on the xtd::collections::generic::list::sync_root property of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance.

In the absence of a synchronized method on a collection, the expected usage for the xtd::collections::generic::list::sync_root looks as follows:

list& my_collection = some_collection;
lock_(my_collection.sync_root()) {
  // Some operation on the collection, which is now thread safe.
}
@encode
@remarks Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.
@remarks The following code example shows how to lock the collection using the xtd::collections::generic::list::sync_root property during the entire enumeration.
@code
list& my_collection = some_collection;
lock_(my_collection.sync_root()) {
  for (auto item : my_collection) {
    // Insert your code here.
  }
}

add() [1/2]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::add ( const type_t & item )

inlineoverride

Adds an object to the end of the xtd::collections::generic::list <type_t>.

Parameters

item

The object to be added to the end of the xtd::collections::generic::list <type_t>. @)ar Examples The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>. #include <xtd/xtd> // Simple business object. A part_id is used to identify the type of part // but the part name can change. class part : public object, public iequatable<part> { public: string part_name; int part_id = 0; part() = default; part(const string& name, int id) : part_name {name}, part_id {id} {} string to_string() const noexcept override {return string::format("ID: {} Name: {}", part_id, part_name);} bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));} bool equals(const part& other) const noexcept override {return part_id == other.part_id;} size get_hash_code() const noexcept override {return part_id;} }; class example { public: static auto main() -> void { // Create a list of parts. auto parts = list<part>(); // Add parts to the list. parts.add(part {"crank arm", 1234}); parts.add(part {"chain ring", 1334}); parts.add(part {"regular seat", 1434}); parts.add(part {"banana seat", 1444}); parts.add(part {"cassette", 1534}); parts.add(part {"shift lever", 1634}); // Write out the parts in the list. This will call the overridden ToString method // in the part class. console::write_line(); for (auto part : parts) console::write_line(part); // Check the list for part #1734. This calls the iequatable::equals method of the part class, which checks the partId for equality. console::write_line("\ncontains(\"1734\"): {0}", parts.contains(part {"", 1734})); // Insert a new item at position 2. console::write_line("\nInsert(2, \"1834\")"); parts.insert(2, part {"brake lever", 1834}); //console::write_line(); for (auto part : parts) console::write_line(part); console::write_line("\nparts[3]: {0}", parts[3]); console::write_line("\nremove(\"1534\")"); // This will remove part 1534 even though the partName is different, because the equals method only checks part_id for equality. parts.remove(part {"cogs", 1534}); console::write_line(); for (auto part : parts) console::write_line(part); console::write_line("\nremove_at(3)"); // This will remove the part at index 3. parts.remove_at(3); console::write_line(); for (auto part : parts) console::write_line(part); } }; startup_(example::main); // This code produces the following output : // // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1534 Name: cassette // ID: 1634 Name: shift lever // // contains("1734"): false // // Insert(2, "1834") // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1534 Name: cassette // ID: 1634 Name: shift lever // // parts[3]: ID: 1434 Name: regular seat // // remove("1534") // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1634 Name: shift lever // // remove_at(3) // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1444 Name: banana seat // ID: 1634 Name: shift lever The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class, including the xtd::collections::generic::list::add method. The parameterless constructor is used to create a list of strings with a capacity of 0. The xtd::collections::generic::list::capacity property is displayed, and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

Other properties and methods are used to search for, insert, and remove elements from the list, and finally to clear the list.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

If xtd::collections::generic::list::count already equals xtd::collections::generic::list::capacity, the capacity of the xtd::collections::generic::list <type_t> is increased by automatically reallocating the internal array, and the existing elements are copied to the new array before the new element is added.

If xtd::collections::generic::list::count is less than xtd::collections::generic::list::capacity, this method is an O(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an O(n) operation, where n is xtd::collections::generic::list::count.

add() [2/2]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::add ( type_t && item )

inline

Adds an object to the end of the xtd::collections::generic::list <type_t>.

Parameters

item

The object to be added to the end of the xtd::collections::generic::list <type_t>. @)ar Examples The following example demonstrates how to add, remove, and insert a simple business object in a xtd::collections::generic::list <type_t>. #include <xtd/xtd> // Simple business object. A part_id is used to identify the type of part // but the part name can change. class part : public object, public iequatable<part> { public: string part_name; int part_id = 0; part() = default; part(const string& name, int id) : part_name {name}, part_id {id} {} string to_string() const noexcept override {return string::format("ID: {} Name: {}", part_id, part_name);} bool equals(const object& obj) const noexcept override {return is<part>(obj) && equals(as<part>(obj));} bool equals(const part& other) const noexcept override {return part_id == other.part_id;} size get_hash_code() const noexcept override {return part_id;} }; class example { public: static auto main() -> void { // Create a list of parts. auto parts = list<part>(); // Add parts to the list. parts.add(part {"crank arm", 1234}); parts.add(part {"chain ring", 1334}); parts.add(part {"regular seat", 1434}); parts.add(part {"banana seat", 1444}); parts.add(part {"cassette", 1534}); parts.add(part {"shift lever", 1634}); // Write out the parts in the list. This will call the overridden ToString method // in the part class. console::write_line(); for (auto part : parts) console::write_line(part); // Check the list for part #1734. This calls the iequatable::equals method of the part class, which checks the partId for equality. console::write_line("\ncontains(\"1734\"): {0}", parts.contains(part {"", 1734})); // Insert a new item at position 2. console::write_line("\nInsert(2, \"1834\")"); parts.insert(2, part {"brake lever", 1834}); //console::write_line(); for (auto part : parts) console::write_line(part); console::write_line("\nparts[3]: {0}", parts[3]); console::write_line("\nremove(\"1534\")"); // This will remove part 1534 even though the partName is different, because the equals method only checks part_id for equality. parts.remove(part {"cogs", 1534}); console::write_line(); for (auto part : parts) console::write_line(part); console::write_line("\nremove_at(3)"); // This will remove the part at index 3. parts.remove_at(3); console::write_line(); for (auto part : parts) console::write_line(part); } }; startup_(example::main); // This code produces the following output : // // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1534 Name: cassette // ID: 1634 Name: shift lever // // contains("1734"): false // // Insert(2, "1834") // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1534 Name: cassette // ID: 1634 Name: shift lever // // parts[3]: ID: 1434 Name: regular seat // // remove("1534") // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1434 Name: regular seat // ID: 1444 Name: banana seat // ID: 1634 Name: shift lever // // remove_at(3) // // ID: 1234 Name: crank arm // ID: 1334 Name: chain ring // ID: 1834 Name: brake lever // ID: 1444 Name: banana seat // ID: 1634 Name: shift lever The following example demonstrates several properties and methods of the xtd::collections::generic::list <type_t> generic class, including the xtd::collections::generic::list::add method. The parameterless constructor is used to create a list of strings with a capacity of 0. The xtd::collections::generic::list::capacity property is displayed, and then the xtd::collections::generic::list::add method is used to add several items. The items are listed, and the xtd::collections::generic::list::capacity property is displayed again, along with the xtd::collections::generic::list::count property, to show that the capacity has been increased as needed.

Other properties and methods are used to search for, insert, and remove elements from the list, and finally to clear the list.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    dinosaurs.add("Tyrannosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Compsognathus");
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    console::write_line("\ncontains(\"Deinonychus\"): {0}", dinosaurs.contains("Deinonychus"));
    
    console::write_line("\ninsert(2, \"Compsognathus\")");
    dinosaurs.insert(2, "Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    // Shows accessing the list using the Item property.
    console::write_line("\ndinosaurs[3]: {0}", dinosaurs[3]);
    
    console::write_line("\nremove(\"Compsognathus\")");
    dinosaurs.remove("Compsognathus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    dinosaurs.trim_excess();
    console::write_line("\ntrim_excess()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
    
    dinosaurs.clear();
    console::write_line("\nclear()");
    console::write_line("capacity: {0}", dinosaurs.capacity());
    console::write_line("count: {0}", dinosaurs.count());
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// capacity: 0
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// capacity: 8
// count: 5
//
// contains("Deinonychus"): true
//
// insert(2, "Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Compsognathus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// dinosaurs[3]: Mamenchisaurus
//
// remove("Compsognathus")
//
// Tyrannosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
// Compsognathus
//
// trim_excess()
// capacity: 5
// count: 5
 
// clear()
// capacity: 5
// count: 0

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

If xtd::collections::generic::list::count already equals xtd::collections::generic::list::capacity, the capacity of the xtd::collections::generic::list <type_t> is increased by automatically reallocating the internal array, and the existing elements are copied to the new array before the new element is added.

If xtd::collections::generic::list::count is less than xtd::collections::generic::list::capacity, this method is an O(1) operation. If the capacity needs to be increased to accommodate the new element, this method becomes an O(n) operation, where n is xtd::collections::generic::list::count.

add_range() [1/2]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::add_range ( const xtd::collections::generic::ienumerable< type_t > & enumerable )

inline

Adds copy of elements from the specified collection to the end of the xtd::collections::generic::list <type_t>.

Parameters

collection

The collection whose elements should be added to the end of the xtd::collections::generic::list <type_t>.

Examples

The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

Remarks

The order of the elements in the collection is preserved in the xtd::collections::generic::list <type_t>.

If the new xtd::collections::generic::list::count (the current xtd::collections::generic::list::count plus the size of the collection) will be greater than xtd::collections::generic::list::capacity, the capacity of the xtd::collections::generic::list <type_t> is increased by automatically reallocating the internal array to accommodate the new elements, and the existing elements are copied to the new array before the new elements are added.

If the xtd::collections::generic::list <type_t> can accommodate the new elements without increasing the xtd::collections::generic::list::capacity, this method is an O(n) operation, where n is the number of elements to be added. If the capacity needs to be increased to accommodate the new elements, this method becomes an O(n + m) operation, where n is the number of elements to be added and m is xtd::collections::generic::list::count.

add_range() [2/2]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::add_range ( std::initializer_list< type_t > il )

inline

Adds copy of elements from the specified collection to the end of the xtd::collections::generic::list <type_t>.

Parameters

il	The collection whose elements should be added to the end of the xtd::collections::generic::list <type_t>.

Examples

The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

Remarks

The order of the elements in the collection is preserved in the xtd::collections::generic::list <type_t>.

If the new xtd::collections::generic::list::count (the current xtd::collections::generic::list::count plus the size of the collection) will be greater than xtd::collections::generic::list::capacity, the capacity of the xtd::collections::generic::list <type_t> is increased by automatically reallocating the internal array to accommodate the new elements, and the existing elements are copied to the new array before the new elements are added.

If the xtd::collections::generic::list <type_t> can accommodate the new elements without increasing the xtd::collections::generic::list::capacity, this method is an O(n) operation, where n is the number of elements to be added. If the capacity needs to be increased to accommodate the new elements, this method becomes an O(n + m) operation, where n is the number of elements to be added and m is xtd::collections::generic::list::count.

as_read_only()

template<class type_t, class allocator_t>

read_only_collection xtd::collections::generic::list< type_t, allocator_t >::as_read_only ( ) const

inlinenoexcept

Returns a read-only xtd::collections::object_model::read_only_collection <type_t> wrapper for the current collection.

Returns

An object that acts as a read-only wrapper around the current xtd::collections::generic::list <type_t>.

Remarks

To prevent any modifications to the xtd::collections::generic::list <type_t> object, expose it only through this wrapper. A xtd::collections::object_model::read_only_collection <type_t> object does not expose methods that modify the collection. However, if changes are made to the underlying xtd::collections::generic::list <type_t> object, the read-only collection reflects those changes.

This method is an O(1) operation.

assign() [1/3]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::assign ( size_type count, const type_t & value )

inline

Replaces the contents with count copies of value value.

Parameters

count	The new size of the container.
value	The value to initialize elements of the container with.

assign() [2/3]

template<class type_t, class allocator_t>

template<class input_iterator_t>

void xtd::collections::generic::list< type_t, allocator_t >::assign ( input_iterator_t first, input_iterator_t last )

inline

Replaces the contents with copies of those in the range [first, last).

Parameters

first	The first iterator the range to copy the elements from.
last	The last iterator the range to copy the elements from.

Warning

The behavior is undefined if either argument is an iterator this current instance.

assign() [3/3]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::assign ( std::initializer_list< type_t > items )

inlinevirtual

Replaces the contents with the elements from the initializer list items.

Parameters

items

the initializer list to copy the values from.

at() [1/2]

template<class type_t, class allocator_t>

virtual reference xtd::collections::generic::list< type_t, allocator_t >::at ( size_type index )

inlinevirtual

Returns a reference to the element at specified location pos, with bounds checking.

Parameters

index

The position of the element to return.

Returns

Reference to the requested element.

Exceptions

std::out_of_range

If pos is not within the range of the container.

at() [2/2]

template<class type_t, class allocator_t>

virtual const_reference xtd::collections::generic::list< type_t, allocator_t >::at ( size_type index ) const

inlinevirtual

Returns a reference to the element at specified location pos, with bounds checking.

Parameters

index

The position of the element to return.

Returns

Reference to the requested element.

Exceptions

std::out_of_range

If pos is not within the range of the container.

binary_search() [1/3]

template<class type_t, class allocator_t>

xtd::size xtd::collections::generic::list< type_t, allocator_t >::binary_search ( const type_t & item ) const

inline

Searches the entire sorted xtd::collections::generic::list <type_t> for an element using the default comparer and returns the zero-based index of the element.

Parameters

item	The object to locate.

Returns

The zero-based index of item in the sorted xtd::collections::generic::list <type_t>, if item is found; otherwise, a number greater than xtd::collections::genric::list::count that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of xtd::collections::genric::list::count.

Exceptions

xtd::invalid_operation_exception

The default comparer xtd::collections::generic::comparer::default_comparer cannot find an implementation of the xtd::icomparable <type_t> generic interface.

Examples

The xtd::collections::generic::list::binary_search method overload is then used to search for two strings that are not in the list, and the xtd::collections::generic::list::insert method is used to insert them. The return value of the xtd::collections::generic::list::binary_search method is greater than xtd::collections::generic::list::count in each case, because the strings are not in the list. Taking the bitwise complement of this number produces the index of the first element in the list that is larger than the search string, and inserting at this location preserves the sort order. The second search string is larger than any element in the list, so the insertion position is at the end of the list.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Pachycephalosaurus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Mamenchisaurus");
    dinosaurs.add("Deinonychus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nsort");
    dinosaurs.sort();
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nbinary_search and insert \"Coelophysis\":");
    auto index = dinosaurs.binary_search("Coelophysis");
    if (index > dinosaurs.count()) dinosaurs.insert(~index, "Coelophysis");
    
    console::write_line();
    for (string dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nbinary_search and insert \"Tyrannosaurus\":");
    index = dinosaurs.binary_search("Tyrannosaurus");
    if (index > dinosaurs.count()) dinosaurs.insert(~index, "Tyrannosaurus");
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Pachycephalosaurus
// Amargasaurus
// Mamenchisaurus
// Deinonychus
//
// sort
//
// Amargasaurus
// Deinonychus
// Mamenchisaurus
// Pachycephalosaurus
//
// binary_search and insert "Coelophysis":
//
// Amargasaurus
// Coelophysis
// Deinonychus
// Mamenchisaurus
// Pachycephalosaurus
//
// binary_search and insert "Tyrannosaurus":
//
// Amargasaurus
// Coelophysis
// Deinonychus
// Mamenchisaurus
// Pachycephalosaurus
// Tyrannosaurus

Remarks

This method uses the default comparer xtd::collections::generic::comparer::default_comparer for type type_t to determine the order of list elements. The xtd::collections::generic::comparer::default_comparer property checks whether type type_t implements the xtd::icomparable <type_t> generic interface and uses that implementation, if available. If not, xtd::collections::generic::comparer::default_comparer checks whether type type_t implements the xtd::icomparable interface. If type type_t does not implement either interface, xtd::collections::generic::comparer::default_comparer throws an xtd::invalid_operation_exception.

The xtd::collections::generic::list <type_t> must already be sorted according to the comparer implementation; otherwise, the result is incorrect.

If the xtd::collections::generic::list <type_t> contains more than one element with the same value, the method returns only one of the occurrences, and it might return any one of the occurrences, not necessarily the first one.

If the xtd::collections::generic::list <type_t> does not contain the specified value, the method returns an integer greater than xtd::collections::generic::list::count. You can apply the bitwise complement operation (~) to this integer to get the index of the first element that is larger than the search value. When inserting the value into the xtd::collections::generic::list <type_t>, this index should be used as the insertion point to maintain the sort order.

This method is an O(log n) operation, where n is the number of elements in the range.

The following code example demonstrates the xtd::collections::generic::list::sort() method overload and the xtd::collections::generic::list::binary_search method overload. A xtd::collections::generic::list <type_t> of strings is created and populated with four strings, in no particular order. The list is displayed, sorted, and displayed again.

binary_search() [2/3]

template<class type_t, class allocator_t>

xtd::size xtd::collections::generic::list< type_t, allocator_t >::binary_search ( const type_t & item, const xtd::collections::generic::icomparer< type_t > & comparer ) const

inline

Searches the entire sorted xtd::collections::generic::list <type_t> for an element using the specified comparer and returns the zero-based index of the element.

Parameters

item	The object to locate.
comparer	The xtd::collections::generic::icomparer <type_t> implementation to use when comparing elements.

Returns

The zero-based index of item in the sorted xtd::collections::generic::list <type_t>, if item is found; otherwise, a number greater than xtd::collections::genric::list::count that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of xtd::collections::genric::list::count.

Exceptions

xtd::invalid_operation_exception

The default comparer xtd::collections::generic::comparer::default_comparer cannot find an implementation of the xtd::icomparable <type_t> generic interface.

Remarks

The comparer customizes how the elements are compared. For example, you can use a xtd::case_insensitive_comparer instance as the comparer to perform case-insensitive string searches.

If comparer is provided, the elements of the xtd::collections::generic::list <type_t> are compared to the specified value using the specified xtd::collections::generic::icomparer <type_t> implementation.

The xtd::collections::generic::list <type_t> must already be sorted according to the comparer implementation; otherwise, the result is incorrect.

If the xtd::collections::generic::list <type_t> contains more than one element with the same value, the method returns only one of the occurrences, and it might return any one of the occurrences, not necessarily the first one.

If the xtd::collections::generic::list <type_t> does not contain the specified value, the method returns an integer greater than xtd::collections::generic::list::count. You can apply the bitwise complement operation (~) to this integer to get the index of the first element that is larger than the search value. When inserting the value into the xtd::collections::generic::list <type_t>, this index should be used as the insertion point to maintain the sort order.

This method is an O(log n) operation, where n is the number of elements in the range.

binary_search() [3/3]

template<class type_t, class allocator_t>

xtd::size xtd::collections::generic::list< type_t, allocator_t >::binary_search ( xtd::size index, xtd::size count, const type_t & item, const xtd::collections::generic::icomparer< type_t > & comparer ) const

inline

Searches a range of elements in the sorted xtd::collections::generic::list <type_t> for an element using the specified comparer and returns the zero-based index of the element.

Parameters

index	The zero-based starting index of the range to search.
count	The length of the range to search.
item	The object to locate.
comparer	The xtd::collections::generic::icomparer <type_t> implementation to use when comparing elements, or null to use the default comparer xtd::collections::generic::comparer<type_t>::default_comparer.

Returns

The zero-based index of item in the sorted xtd::collections::generic::list <type_t>, if item is found; otherwise, a number greater than xtd::collections::genric::list::count that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of xtd::collections::genric::list::count.

Exceptions

xtd::argument_exception	`index` and `count` do not denote a valid range in the xtd::collections::generic::list <type_t>.
xtd::invalid_operation_exception	The default comparer xtd::collections::generic::comparer::default_comparer cannot find an implementation of the xtd::icomparable <type_t> generic interface.

Remarks

The comparer customizes how the elements are compared. For example, you can use a xtd::case_insensitive_comparer instance as the comparer to perform case-insensitive string searches.

If comparer is provided, the elements of the xtd::collections::generic::list <type_t> are compared to the specified value using the specified xtd::collections::generic::icomparer <type_t> implementation.

The xtd::collections::generic::list <type_t> must already be sorted according to the comparer implementation; otherwise, the result is incorrect.

If the xtd::collections::generic::list <type_t> contains more than one element with the same value, the method returns only one of the occurrences, and it might return any one of the occurrences, not necessarily the first one.

If the xtd::collections::generic::list <type_t> does not contain the specified value, the method returns an integer greater than xtd::collections::generic::list::count. You can apply the bitwise complement operation (~) to this integer to get the index of the first element that is larger than the search value. When inserting the value into the xtd::collections::generic::list <type_t>, this index should be used as the insertion point to maintain the sort order.

This method is an O(log n) operation, where n is the number of elements in the range.

clear()

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::clear ( )

inlineoverride

Removes all elements from the xtd::collections::generic::list <type_t>.

Remarks

xtd::collections::generic::list::count is set to 0, and references to other objects from elements of the collection are also released.

xtd::collections::generic::list::capacity remains unchanged. To reset the capacity of the xtd::collections::generic::list <type_t>, call the xtd::collections::generic::list::trim_excess method or set the xtd::collections::generic::list::capacity property directly. Decreasing the capacity reallocates memory and copies all the elements in the xtd::collections::generic::list <type_t>. Trimming an empty xtd::collections::generic::list <type_t> sets the capacity of the xtd::collections::generic::list <type_t> to the default capacity.

This method is an O(n) operation, where n is xtd::collections::generic::list::count.

contains()

template<class type_t, class allocator_t>

bool xtd::collections::generic::list< type_t, allocator_t >::contains ( const type_t & value ) const

inlineoverridenoexcept

Determines whether an element is in the xtd::colllections::generic::list <type_t>.

Parameters

value

The object to locate in the xtd::colllections::generic::list <type_t>. The value can be null for reference types.

Returns

true if item is found in the xtd::colllections::generic::list <type_t>; otherwise, false.

convert_all()

template<class type_t, class allocator_t>

template<class output_t>

list< output_t > xtd::collections::generic::list< type_t, allocator_t >::convert_all ( xtd::converter< output_t, const type_t & > converter ) const

inline

Converts the elements in the current xtd::colllections::generic::list <type_t> to another type, and returns a list containing the converted elements.

Template Parameters

output_t

The type of the elements of the target array.

Parameters

converter

A xtd::converter <output_t, input_t> delegate that converts each element from one type to another type.

Returns

A xtd::collections::generic::list <type_t> of the target type containing the converted elements from the current xtd::collections::generic::list <type_t>.

Examples

The following example defines a method named point_f_to_point that converts a xtd::drawing::point_f structure to a xtd::drawing::point structure. The example then creates a xtd::collections::generic::list <type_t> of xtd::drawing::point_f structures, creates a xtd::converter <point_f, point> delegate to represent the point_f_to_point method, and passes the delegate to the xtd::collections::generic::list::convert_all method. The xtd::collections::generic::list::convert_all method passes each element of the input list to the point_f_to_point method and puts the converted elements into a new list of Point structures. Both lists are displayed.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto lpf = list<drawing::point_f> {};
    
    lpf.add(drawing::point_f {27.8f, 32.62f});
    lpf.add(drawing::point_f {99.3f, 147.273f});
    lpf.add(drawing::point_f {7.5f, 1412.2f});
    
    console::write_line();
    for (const auto& p : lpf)
      console::write_line(p);
    
    list<drawing::point> lp = lpf.convert_all(converter<drawing::point, const drawing::point_f&> {point_f_to_point});
    
    console::write_line();
    for (const auto& p : lp)
      console::write_line(p);
  }
 
  static drawing::point point_f_to_point(const drawing::point_f& pf) {
    return {as<int>(pf.x), as<int>(pf.y)};
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// {x=27.8, y=32.62}
// {x=99.3, y=147.273}
// {x=7.5, y=1412.2}
//
// {x=28, y=33}
// {x=99, y=147}
// {x=8, y=1412}

copy_to() [1/3]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::copy_to ( xtd::array< type_t > & array ) const

inlinevirtual

Copies the entire xtd::collections::generic::list <type_t> to a compatible one-dimensional array.

Parameters

array

The one-dimensional xtd::array that is the destination of the elements copied from ICollection. The xtd::array must have zero-based indexing.

Exceptions

ArgumentNullException	array is null.
ArgumentException	The number of elements in the source xtd::collections::generic::list <type_t> is greater than the number of elements that the destination array can contain.

Examples

The following code example demonstrates all three overloads of the CopyTo method. A xtd::collections::generic::list <type_t> of strings is created and populated with 5 strings. An empty string array of 15 elements is created, and the copy_to(type_t[]) method overload is used to copy all the elements of the list to the array beginning at the first element of the array. The CopyTo(type_t[], Int32) method overload is used to copy all the elements of the list to the array beginning at array index 6 (leaving index 5 empty). Finally, the CopyTo(Int32, type_t[], Int32, Int32) method overload is used to copy 3 elements from the list, beginning with index 2, to the array beginning at array index 12 (leaving index 11 empty). The contents of the array are then displayed.

Remarks

TThis method uses xtd::array::copy to copy the elements.

The elements are copied to the xtd::array in the same order in which the enumerator iterates through the xtd::collections::generic::list <type_t>.

This method is an O(n) operation, where n is xtd::collections::generic::list::count.

copy_to() [2/3]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::copy_to ( xtd::array< type_t > & array, size_type array_index ) const

inlineoverride

Copies the entire xtd::colllections::generic::list <type_t> to a compatible one-dimensional array, starting at the specified index of the target array.

Parameters

array	The one-dimensional Array that is the destination of the elements copied from xtd::colllections::generic::list <type_t>. The Array must have zero-based indexing.
array_index	The zero-based index in array at which copying begins.

Exceptions

xtd::argument_exception

The number of elements in the source xtd::colllections::generic::list <type_t> is greater than the available space from arrayIndex to the end of the destination array.

Remarks

This method uses xtd::array::copy to copy the elements.

The elements are copied to the xtd::array in the same order in which the enumerator iterates through the xtd::colllections::generic::list <type_t>.

This method is an O(n) operation, where n is xtd::colllections::generic::list::count.

copy_to() [3/3]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::copy_to ( size_type index, xtd::array< type_t > & array, size_type array_index, size_type count ) const

inlinevirtual

Copies the entire xtd::collections::generic::list <type_t> to a compatible one-dimensional array, starting at the specified index of the target array.

Parameters

index	The zero-based index in the source xtd::collections::generic::list <type_t> at which copying begins.
array	The one-dimensional xtd::array that is the destination of the elements copied from ICollection. The xtd::array must have zero-based indexing.
arrayIndex	The zero-based index in array at which copying begins;
count	The number of elements to copy.

Exceptions

ArgumentNullException	array is null.
ArgumentOutOfRangeException	The arrayIndex or count is less than 0.
ArgumentException	The number of elements in the source xtd::collections::generic::list <type_t> is greater than the number of elements that the destination array can contain.

Examples

The following code example demonstrates all three overloads of the CopyTo method. A xtd::collections::generic::list <type_t> of strings is created and populated with 5 strings. An empty string array of 15 elements is created, and the CopyTo(type_t[]) method overload is used to copy all the elements of the list to the array beginning at the first element of the array. The CopyTo(type_t[], Int32) method overload is used to copy all the elements of the list to the array beginning at array index 6 (leaving index 5 empty). Finally, the CopyTo(Int32, type_t[], Int32, Int32) method overload is used to copy 3 elements from the list, beginning with index 2, to the array beginning at array index 12 (leaving index 11 empty). The contents of the array are then displayed.

Remarks

TThis method uses xtd::array::copy to copy the elements.

The elements are copied to the xtd::array in the same order in which the enumerator iterates through the xtd::collections::generic::list <type_t>.

This method is an O(n) operation, where n is xtd::collections::generic::list::count.

emplace()

template<class type_t, class allocator_t>

template<class ... args_t>

iterator xtd::collections::generic::list< type_t, allocator_t >::emplace ( const_iterator pos, args_t &&... args )

inline

Inserts a new element into the container directly before pos.

Parameters

pos	The iterator before which the new element will be constructed.
args	arguments to forward to the constructor of the element.

Remarks

The element is constructed through std::allocator_traits::construct, which typically uses placement-new to construct the element in-place at a location provided by the container. However, if the required location has been occupied by an existing element, the inserted element is constructed at another location at first, and then move assigned into the required location.

The arguments args... are forwarded to the constructor as std::forward<args_t>(args).... args... may directly or indirectly refer to a value in the container.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

emplace_back()

template<class type_t, class allocator_t>

template<class ... args_t>

reference xtd::collections::generic::list< type_t, allocator_t >::emplace_back ( args_t &&... args )

inline

Appends a new element to the end of the container. The element is constructed through std::allocator_traits::construct, which typically uses placement-new to construct the element in-place at the location provided by the container. The arguments args... are forwarded to the constructor as std::forward<Args>(args)....

Parameters

args	The arguments to forward to the constructor of the element.

Returns

A reference to the inserted element.

Remarks

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise only the xtd::collections::generic::list::end() iterator is invalidated.

ensure_capacity()

template<class type_t, class allocator_t>

xtd::size xtd::collections::generic::list< type_t, allocator_t >::ensure_capacity ( xtd::size capacity )

inline

Ensures that the capacity of this list is at least the specified capacity. If the current capacity is less than capacity, it is increased to at least the specified capacity.

Parameters

capacity

The minimum capacity to ensure.

Returns

The new capacity of this list.

equals()

template<class type_t, class allocator_t>

bool xtd::collections::generic::list< type_t, allocator_t >::equals ( const object & obj ) const

inlineoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Examples

The following code example compares the current instance with another object.

#include <xtd/xtd>
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::object.

Reimplemented in xtd::diagnostics::trace_listener_collection.

index_of()

template<class type_t, class allocator_t>

virtual size_type xtd::collections::generic::list< type_t, allocator_t >::index_of ( const type_t & value, size_type index, size_type count ) const

inlinevirtual

Erases the specified elements from the container.

Parameters

pos	The iterator to the element to remove.

Returns

Iterator following the last removed element.

Remarks

Removes the element at pos.

Iterators (including the xtd::collections::generic::list::end() iterator) and references to the elements at or after the point of the erase are invalidated.

The iterator pos must be valid and dereferenceable. Thus the xtd::collections::generic::list::end() iterator (which is valid, but is not dereferenceable) cannot be used as a value for pos. / @remarks Ifposrefers to the last element, then thextd::collections::generic::list:: end() iterator is returned. virtual iterator erase(const_iterator pos) { ++data_->version; return to_type_iterator(data_->items.erase(to_const_base_type_iterator(pos))); } / @brief Erases the specified elements from the container. / @param pos The iterator to the element to remove. / @return Iterator following the last removed element. / @remarks Removes the elements in the range [first,last). / @remarks Iterators (including the xtd::collections::generic::list::end() iterator) and references to the elements at or after the point of the erase are invalidated. / @remarks The iteratorfirstdoes not need to be dereferenceable iffirst == last: erasing an empty range is a no-op. / @remarks Iflast == end()prior to removal, then the updated xtd::collections::generic::list::end() iterator is returned. / @remarks If [first,last) is an empty range, thenlast` is returned. virtual iterator erase(const_iterator first, const_iterator last) { ++data_->version; return to_type_iterator(data_->items.erase(to_const_base_type_iterator(first), to_const_base_type_iterator(last))); }

/ Determines whether the xtd::collections::generic::list <type_t> contains elements that match the conditions defined by the specified predicate. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

true if the xtd::collections::generic::list <type_t> contains one or more elements that match the conditions defined by the specified predicate; otherwise, false. /

Examples

/ The following example demonstrates the xtd::collections::generic::list::exists method and several other methods that use the xtd::predicate <type_t> generic delegate. /
A xtd::collections::generic::list <type_t> of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The example also defines a search predicate method named ends_with_saurus, which accepts a string parameter and returns a boolean value indicating whether the input string ends in "saurus". /
The xtd::collections::generic::list::find, xtd::collections::generic::list::find_last, and xtd::collections::generic::list::findA_all methods are used to search the list with the search predicate method, and then the xtd::collections::generic::list::remove_all method is used to remove all entries ending with "saurus". /
Finally, the xtd::collections::generic::list::exists method is called. It traverses the list from the beginning, passing each element in turn to the ends_with_saurus method. The search stops and the method returns true if the ends_with_saurus method returns true for any element. The xtd::collections::generic::list::exists method returns false because all such elements have been removed. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Compsognathus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Oviraptor");
    dinosaurs.add("Velociraptor");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Dilophosaurus");
    dinosaurs.add("Gallimimus");
    dinosaurs.add("Triceratops");
    
    console::write_line();
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ntrue_for_all(ends_with_saurus): {0}", dinosaurs.true_for_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind(ends_with_saurus): {0}", dinosaurs.find(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfindLast(ends_with_saurus): {0}", dinosaurs.find_last(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind_all(ends_with_saurus):");
    auto sublist = dinosaurs.find_all(predicate<const string&> {ends_with_saurus});
    
    for (const auto& dinosaur : sublist)
      console::write_line(dinosaur);
    
    console::write_line("\n{0} elements removed by remove_all(ends_with_saurus).", dinosaurs.remove_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nlist now contains:");
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nexists(ends_with_saurus): {0}", dinosaurs.exists(predicate<const string&> {ends_with_saurus}));
  }
  
private:
  // Search predicate returns true if a string ends in "saurus".
  static bool ends_with_saurus(const string& s) {
    return s.to_lower().ends_with("saurus");
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Compsognathus
// Amargasaurus
// Oviraptor
// Velociraptor
// Deinonychus
// Dilophosaurus
// Gallimimus
// Triceratops
//
// true_for_all(ends_with_saurus): false
//
// find(ends_with_saurus): Amargasaurus
//
// findLast(ends_with_saurus): Dilophosaurus
//
// find_all(ends_with_saurus):
// Amargasaurus
// Dilophosaurus
//
// 2 elements removed by remove_all(ends_with_saurus).
//
// list now contains:
// Compsognathus
// Oviraptor
// Velociraptor
// Deinonychus
// Gallimimus
// Triceratops
//
// exists(ends_with_saurus): false

/

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. bool exists(xtd::predicate<const type_t&> match) const { for (const auto& item : *this) if (match(item)) return true; return false; }

/ Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire xtd::collections::generic::list <type_t>. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type type_t. /

Examples

/ The following example demonstrates the xtd::collections::generic::list::exists method and several other methods that use the xtd::predicate <type_t> generic delegate. /
A xtd::collections::generic::list <type_t> of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The example also defines a search predicate method named ends_with_saurus, which accepts a string parameter and returns a boolean value indicating whether the input string ends in "saurus". /
The xtd::collections::generic::list::find, xtd::collections::generic::list::find_last, and xtd::collections::generic::list::findA_all methods are used to search the list with the search predicate method, and then the xtd::collections::generic::list::remove_all method is used to remove all entries ending with "saurus". /
Finally, the xtd::collections::generic::list::exists method is called. It traverses the list from the beginning, passing each element in turn to the ends_with_saurus method. The search stops and the method returns true if the ends_with_saurus method returns true for any element. The xtd::collections::generic::list::exists method returns false because all such elements have been removed. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Compsognathus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Oviraptor");
    dinosaurs.add("Velociraptor");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Dilophosaurus");
    dinosaurs.add("Gallimimus");
    dinosaurs.add("Triceratops");
    
    console::write_line();
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ntrue_for_all(ends_with_saurus): {0}", dinosaurs.true_for_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind(ends_with_saurus): {0}", dinosaurs.find(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfindLast(ends_with_saurus): {0}", dinosaurs.find_last(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind_all(ends_with_saurus):");
    auto sublist = dinosaurs.find_all(predicate<const string&> {ends_with_saurus});
    
    for (const auto& dinosaur : sublist)
      console::write_line(dinosaur);
    
    console::write_line("\n{0} elements removed by remove_all(ends_with_saurus).", dinosaurs.remove_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nlist now contains:");
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nexists(ends_with_saurus): {0}", dinosaurs.exists(predicate<const string&> {ends_with_saurus}));
  }
  
private:
  // Search predicate returns true if a string ends in "saurus".
  static bool ends_with_saurus(const string& s) {
    return s.to_lower().ends_with("saurus");
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Compsognathus
// Amargasaurus
// Oviraptor
// Velociraptor
// Deinonychus
// Dilophosaurus
// Gallimimus
// Triceratops
//
// true_for_all(ends_with_saurus): false
//
// find(ends_with_saurus): Amargasaurus
//
// findLast(ends_with_saurus): Dilophosaurus
//
// find_all(ends_with_saurus):
// Amargasaurus
// Dilophosaurus
//
// 2 elements removed by remove_all(ends_with_saurus).
//
// list now contains:
// Compsognathus
// Oviraptor
// Velociraptor
// Deinonychus
// Gallimimus
// Triceratops
//
// exists(ends_with_saurus): false

/

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. type_t find(xtd::predicate<const type_t&> match) const { for (const auto& item : *this) if (match(item)) return item; return type_t {}; }

/ Retrieves all the elements that match the conditions defined by the specified predicate. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

A xtd::collections::generic::list <type_t> containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty xtd::collections::generic::list <type_t>. /

Examples

/ The following example demonstrates the xtd::collections::generic::list::exists method and several other methods that use the xtd::predicate <type_t> generic delegate. /
A xtd::collections::generic::list <type_t> of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The example also defines a search predicate method named ends_with_saurus, which accepts a string parameter and returns a boolean value indicating whether the input string ends in "saurus". /
The xtd::collections::generic::list::find, xtd::collections::generic::list::find_last, and xtd::collections::generic::list::findA_all methods are used to search the list with the search predicate method, and then the xtd::collections::generic::list::remove_all method is used to remove all entries ending with "saurus". /
Finally, the xtd::collections::generic::list::exists method is called. It traverses the list from the beginning, passing each element in turn to the ends_with_saurus method. The search stops and the method returns true if the ends_with_saurus method returns true for any element. The xtd::collections::generic::list::exists method returns false because all such elements have been removed. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Compsognathus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Oviraptor");
    dinosaurs.add("Velociraptor");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Dilophosaurus");
    dinosaurs.add("Gallimimus");
    dinosaurs.add("Triceratops");
    
    console::write_line();
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ntrue_for_all(ends_with_saurus): {0}", dinosaurs.true_for_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind(ends_with_saurus): {0}", dinosaurs.find(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfindLast(ends_with_saurus): {0}", dinosaurs.find_last(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind_all(ends_with_saurus):");
    auto sublist = dinosaurs.find_all(predicate<const string&> {ends_with_saurus});
    
    for (const auto& dinosaur : sublist)
      console::write_line(dinosaur);
    
    console::write_line("\n{0} elements removed by remove_all(ends_with_saurus).", dinosaurs.remove_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nlist now contains:");
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nexists(ends_with_saurus): {0}", dinosaurs.exists(predicate<const string&> {ends_with_saurus}));
  }
  
private:
  // Search predicate returns true if a string ends in "saurus".
  static bool ends_with_saurus(const string& s) {
    return s.to_lower().ends_with("saurus");
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Compsognathus
// Amargasaurus
// Oviraptor
// Velociraptor
// Deinonychus
// Dilophosaurus
// Gallimimus
// Triceratops
//
// true_for_all(ends_with_saurus): false
//
// find(ends_with_saurus): Amargasaurus
//
// findLast(ends_with_saurus): Dilophosaurus
//
// find_all(ends_with_saurus):
// Amargasaurus
// Dilophosaurus
//
// 2 elements removed by remove_all(ends_with_saurus).
//
// list now contains:
// Compsognathus
// Oviraptor
// Velociraptor
// Deinonychus
// Gallimimus
// Triceratops
//
// exists(ends_with_saurus): false

/

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. list<type_t> find_all(xtd::predicate<const type_t&> match) const { auto result = list<type_t> {}; for (const auto& item : *this) if (match(item)) result.add(item); return result; }

/ Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire xtd::collections::generic::list <type_t>. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_index(xtd::predicate<const type_t&> match) const {return find_index(0, size(), match);} / Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the xtd::collections::generic::list <type_t> that extends from the specified index to the last element. /

Parameters

start_index	The zero-based starting index of the search. /
match	The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Exceptions

xtd::argument_out_of_range_exception

`start_index` is outside the range of valid indexes for the xtd::collections::generic::list <type_t>.. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_index(xtd::size start_index, xtd::predicate<const type_t&> match) const {return find_index(start_index, size() - start_index, match);} / Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the xtd::collections::generic::list <type_t> that starts at the specified index and contains the specified number of elements. /

Parameters

start_index	The zero-based starting index of the search. /
count	The number of elements in the section to search. /
match	The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Exceptions

xtd::argument_out_of_range_exception

`start_index` is outside the range of valid indexes for the xtd::collections::generic::list <type_t>. -or- `start_index` and `count` do not specify a valid section in the xtd::collections::generic::list <type_t>. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_index(xtd::size start_index, xtd::size count, xtd::predicate<const type_t&> match) const { if (start_index > size() || start_index + count > size()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument_out_of_range); for (auto index = start_index; index < start_index + count; ++index) if (match((*this)[index])) return index; return npos; }

/ Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire xtd::collections::generic::list <type_t>. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type type_t. /

Examples

/ The following example demonstrates the xtd::collections::generic::list::exists method and several other methods that use the xtd::predicate <type_t> generic delegate. /
A xtd::collections::generic::list <type_t> of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The example also defines a search predicate method named ends_with_saurus, which accepts a string parameter and returns a boolean value indicating whether the input string ends in "saurus". /
The xtd::collections::generic::list::find, xtd::collections::generic::list::find_last, and xtd::collections::generic::list::findA_all methods are used to search the list with the search predicate method, and then the xtd::collections::generic::list::remove_all method is used to remove all entries ending with "saurus". /
Finally, the xtd::collections::generic::list::exists method is called. It traverses the list from the beginning, passing each element in turn to the ends_with_saurus method. The search stops and the method returns true if the ends_with_saurus method returns true for any element. The xtd::collections::generic::list::exists method returns false because all such elements have been removed. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Compsognathus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Oviraptor");
    dinosaurs.add("Velociraptor");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Dilophosaurus");
    dinosaurs.add("Gallimimus");
    dinosaurs.add("Triceratops");
    
    console::write_line();
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ntrue_for_all(ends_with_saurus): {0}", dinosaurs.true_for_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind(ends_with_saurus): {0}", dinosaurs.find(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfindLast(ends_with_saurus): {0}", dinosaurs.find_last(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind_all(ends_with_saurus):");
    auto sublist = dinosaurs.find_all(predicate<const string&> {ends_with_saurus});
    
    for (const auto& dinosaur : sublist)
      console::write_line(dinosaur);
    
    console::write_line("\n{0} elements removed by remove_all(ends_with_saurus).", dinosaurs.remove_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nlist now contains:");
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nexists(ends_with_saurus): {0}", dinosaurs.exists(predicate<const string&> {ends_with_saurus}));
  }
  
private:
  // Search predicate returns true if a string ends in "saurus".
  static bool ends_with_saurus(const string& s) {
    return s.to_lower().ends_with("saurus");
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Compsognathus
// Amargasaurus
// Oviraptor
// Velociraptor
// Deinonychus
// Dilophosaurus
// Gallimimus
// Triceratops
//
// true_for_all(ends_with_saurus): false
//
// find(ends_with_saurus): Amargasaurus
//
// findLast(ends_with_saurus): Dilophosaurus
//
// find_all(ends_with_saurus):
// Amargasaurus
// Dilophosaurus
//
// 2 elements removed by remove_all(ends_with_saurus).
//
// list now contains:
// Compsognathus
// Oviraptor
// Velociraptor
// Deinonychus
// Gallimimus
// Triceratops
//
// exists(ends_with_saurus): false

/

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. type_t find_last(xtd::predicate<const type_t&> match) const { for (auto iterator = rbegin(); iterator != rend(); ++iterator) if (match(*iterator)) return *iterator; return type_t {}; }

/ Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire xtd::collections::generic::list <type_t>. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_last_index(xtd::predicate<const type_t&> match) const {return find_last_index(size() - 1, size(), match);} / Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the xtd::collections::generic::list <type_t> that extends from the first element to the specified index. /

Parameters

start_index	The zero-based starting index of the backward search. /
match	The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Exceptions

xtd::argument_out_of_range_exception

`start_index` is outside the range of valid indexes for the xtd::collections::generic::list <type_t>. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_last_index(xtd::size start_index, xtd::predicate<const type_t&> match) const {return find_last_index(start_index, start_index + 1, match);} / Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the xtd::collections::generic::list <type_t> that contains the specified number of elements and ends at the specified index. /

Parameters

start_index	The zero-based starting index of the backward search. /
count	The number of elements in the section to search. /
match	The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, xtd::collections::generic::list::npos. /

Exceptions

xtd::argument_out_of_range_exception

`start_index` is outside the range of valid indexes for the xtd::collections::generic::list <type_t>. -or- `start_index` and `count` do not specify a valid section in the xtd::collections::generic::list <type_t>. /

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size find_last_index(xtd::size start_index, xtd::size count, xtd::predicate<const type_t&> match) const { if (count > size() || start_index - count + 1 > size()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument); auto end_index = start_index - count; for (auto index = start_index; index > end_index; –index) if (match((*this)[index])) return index; return npos; }

/ Performs the specified action on each element of the xtd::collections::generic::list <type_t>. /

Parameters

action

The xtd::action <type_t> delegate to perform on each element of the xtd::collections::generic::list <type_t>. /

Examples

/ The following example demonstrates the use of the xtd::action <type_t> delegate to print the contents of a xtd::collections::generic::list <type_t> object. In this example the print method is used to display the contents of the list to the console. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto names = list<string> {};
    names.add("Bruce");
    names.add("Alfred");
    names.add("Tim");
    names.add("Richard");
 
    names.for_each(action<const string&> {print});
    
    names.for_each(action<const string&> {[](const string& name) {
      console::write_line(name);
    }});
  }
  
private:
  static void print(const string& s) {
    console::write_line(s);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
// Bruce
// Alfred
// Tim
// Richard
// Bruce
// Alfred
// Tim
// Richard

/

Remarks

The xtd::action <type_t> is a delegate to a method that performs an action on the object passed to it. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::action <type_t> delegate. /

This method is an O(n) operation, where n is xtd::collections::generic::list::count. /

Modifying the underlying collection in the body of the Action<T> delegate is not supported and causes undefined behavior. void for_each(xtd::action<const type_t&> action) { for (const auto& item : *this) action(item); }

/ Returns the allocator associated with the container. /

Returns

The associated allocator. virtual allocator_type get_allocator() const {return data_->items.get_allocator();}

/ Returns the underlying base type. /

Returns

The underlying base type. /

Warning

Don't manipulate the xtd::collections::generic::list::base_type yourself, otherwise the expected result may be undefined. virtual base_type& get_base_type() noexcept {return data_->items;} / Returns the underlying base type. /

Returns

The underlying base type. virtual const base_type& get_base_type() const noexcept {return data_->items;}

/ Returns an enumerator that iterates through the xtd::collections::generic::list <type_t>. /

Returns

A xtd::collections::generic::.enumerator for the xtd::collections::generic::list <type_t>. enumerator<value_type> get_enumerator() const noexcept override { return {new_ptr<enumerator>(*this, data_->version)}; }

/ Creates a shallow copy of a range of elements in the source xtd::collections::generic::list <type_t>. /

Parameters

index	The zero-based xtd::collections::generic::list <type_t> index at which the range starts. /
count	The number of elements in the range. /

Returns

A shallow copy of a range of elements in the source xtd::collections::generic::list <type_t>. /

Exceptions

xtd::argument_exception

index and count do ! denote a valid range of elements in the xtd::collections::generic::list <type_t>. /

Examples

/ The following code example demonstrates the xtd::collections::generic::list::get_range method and other methods of the xtd::collections::generic::list <type_t> class that act on ranges. At the end of the code example, the xtd::collections::generic::list::get_range method is used to get three items from the list, beginning with index location 2. The xtd::collections::generic::ist::to_array method is called on the resulting xtd::collections::generic::list <type_t>, creating an array of three elements. The elements of the array are displayed. /

/

Remarks

A shallow copy of a collection of reference types, or a subset of that collection, contains only the references to the elements of the collection. The objects themselves are ! copied. The references in the new list point to the same objects as the references in the original list. /

A shallow copy of a collection of value types, or a subset of that collection, contains the elements of the collection. However, if the elements of the collection contain references to other objects, those objects are ! copied. The references in the elements of the new collection point to the same objects as the references in the elements of the original collection. /

In contrast, a deep copy of a collection copies the elements and everything directly or indirectly referenced by the elements. /

This method is an O(n) operation, where n is count. list get_range(size_type index, size_type count) { if (index + count > this->count()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument);;

return list<type_t> {begin() + index, begin() + index + count}; }

/ Determines the index of a specific item in the xtd::collections::generic::list <type_t>. /

Parameters

value

The object to locate in the xtd::collections::generic::list <type_t>. /

Returns

The index of value if found in the list; otherwise, xtd::collections::generic::ilist::npos. size_type index_of(const type_t& value) const noexcept override { if (count() == 0) return npos; return index_of(value, 0, count()); }

/ Determines the index of a specific item in the xtd::collections::generic::list <type_t>. /

Parameters

value	The object to locate in the xtd::collections::generic::list <type_t>. /
index	The zero-based starting index of the search. /

Returns

The index of value if found in the xtd::collections::generic::list; otherwise, xtd::collections::generic::ilist::npos. /

Exceptions

xtd::argument_out_of_range_exception

`index` is outside the range of valid indexes for the xtd::collections::generic::list <type_t>. virtual size_type index_of(const type_t& value, size_type index) const {return index_of(value, index, count() - index);}

/ Determines the index of a specific item in the xtd::collections::generic::list <type_t>. /

Parameters

value	The object to locate in the xtd::collections::generic::list <type_t>. /
index	The zero-based starting index of the search. /
count	The number of elements in the section to search /

Returns

The index of value if found in the xtd::collections::generic::list; otherwise, xtd::collections::generic::ilist::npos. /

Exceptions

xtd::argument_out_of_range_exception

`index` and `countù do not specify a valid section in the xtd::collections::generic::list <type_t>.

insert() [1/8]

template<class type_t, class allocator_t>

virtual iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, const type_t & value )

inlinevirtual

Inserts elements at the specified location in the container.

Parameters

pos	the iterator before which the content will be inserted (pos may be the end() iterator).
value	The element value to insert.

Returns

The iterator pointing to the inserted value.

Remarks

Inserts value before pos.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

insert() [2/8]

template<class type_t, class allocator_t>

virtual iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, type_t && value )

inlinevirtual

Inserts elements at the specified location in the container.

Parameters

pos	the iterator before which the content will be inserted (pos may be the end() iterator).
value	The element value to insert.

Returns

The iterator pointing to the inserted value.

Remarks

Inserts value before pos.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

insert() [3/8]

template<class type_t, class allocator_t>

virtual iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, size_type count, const type_t & value )

inlinevirtual

Inserts elements at the specified location in the container.

Parameters

pos	the iterator before which the content will be inserted (pos may be the end() iterator).
count	The number of elements to insert.
value	The element value to insert.

Returns

The iterator pointing to the first element inserted, or pos if count == 0.

Remarks

Iterator pointing to the first element inserted, or pos if count == 0.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

insert() [4/8]

template<class type_t, class allocator_t>

virtual iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, size_type count, type_t && value )

inlinevirtual

Inserts elements at the specified location in the container.

Parameters

pos	the iterator before which the content will be inserted (pos may be the end() iterator).
count	The number of elements to insert.
value	The element value to insert.

Returns

The iterator pointing to the first element inserted, or pos if count == 0.

Remarks

Iterator pointing to the first element inserted, or pos if count == 0.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

insert() [5/8]

template<class type_t, class allocator_t>

template<class input_iterator_t>

iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, input_iterator_t first, input_iterator_t last )

inline

Inserts elements at the specified location in the container.

Parameters

first	The first range of elements to insert, cannot be iterators into container for which insert is called
last	The last range of elements to insert, cannot be iterators into container for which insert is called

Returns

The iterator pointing to the first element inserted, or pos if first == last.

Remarks

Inserts elements from range [first, last) before pos.

If first and last are iterators into *this, the behavior is undefined.

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise, only the iterators and references before the insertion point remain valid.

insert() [6/8]

template<class type_t, class allocator_t>

virtual iterator xtd::collections::generic::list< type_t, allocator_t >::insert ( const_iterator pos, const std::initializer_list< type_t > & items )

inlinevirtual

Inserts elements at the specified location in the container.

Parameters

pos	the iterator before which the content will be inserted (pos may be the end() iterator).
items	The initializer list to insert the values from.

Returns

The iterator pointing to the first element inserted, or pos if items is empty.

Remarks

Inserts value before pos.

Inserts elements from initializer list items before pos.

insert() [7/8]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::insert ( size_type index, const type_t & value )

inlineoverride

Inserts an element into the xtd::collections::generic::list <type_t> at the specified index.

Parameters

index	The zero-based index at which the new element should be inserted.
value	The element should be inserted into the xtd::collections::generic::list <type_t>.

Exceptions

xtd::argument_out_of_range_exception

index is is greater than xtd::collections::generic::list::count.

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

insert() [8/8]

template<class type_t, class allocator_t>

void xtd::collections::generic::list< type_t, allocator_t >::insert ( size_type index, type_t && value )

inline

Inserts an element into the xtd::collections::generic::list <type_t> at the specified index.

Parameters

index	The zero-based index at which the new element should be inserted.
value	The element should be inserted into the xtd::collections::generic::list <type_t>.

Exceptions

xtd::argument_out_of_range_exception

index is is greater than xtd::collections::generic::list::count.

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

insert_range() [1/2]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::insert_range ( size_type index, const xtd::collections::generic::ienumerable< type_t > & enumerable )

inlinevirtual

Inserts copy of elements from a collection into the xtd::collections::generic::list <type_t> at the specified index.

Parameters

index	The zero-based index at which the new elements should be inserted.
collection	The collection whose elements should be inserted into the xtd::collections::generic::list <type_t>.

Exceptions

xtd::argument_out_of_range_exception

index is is greater than xtd::collections::generic::list::count.

Examples

The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

The order of the elements in the collection is preserved in the xtd::collections::generic::list <type_t>.

insert_range() [2/2]

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::insert_range ( size_type index, const std::initializer_list< type_t > & items )

inlinevirtual

Inserts copy of elements from a collection into the xtd::collections::generic::list <type_t> at the specified index.

Parameters

index	The zero-based index at which the new elements should be inserted.
collection	The collection whose elements should be inserted into the xtd::collections::generic::list <type_t>.

Exceptions

xtd::argument_out_of_range_exception

index is is greater than xtd::collections::generic::list::count.

Examples

The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements.

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

Remarks

xtd::collections::generic::list <type_t> allows duplicate elements.

The order of the elements in the collection is preserved in the xtd::collections::generic::list <type_t>.

last_index_of()

template<class type_t, class allocator_t>

size_type xtd::collections::generic::list< type_t, allocator_t >::last_index_of ( const type_t & value ) const

inline

Determines the last index of a specific item in the xtd::collections::generic::list <type_t>.

Parameters

value

The object to locate in the xtd::collections::generic::list <type_t>.

Returns

Int32 The last index of value if found in the list; otherwise, xtd::collections::generic::list::npos.

resize()

template<class type_t, class allocator_t>

virtual void xtd::collections::generic::list< type_t, allocator_t >::resize ( size_type count )

inlinevirtual

Determines the last index of a specific item in the xtd::collections::generic::list <type_t>.

Parameters

value	The object to locate in the xtd::collections::generic::list <type_t>.
index	The zero-based starting index of the search.

Returns

Int32 The last index of value if found in the list; otherwise, xtd::collections::generic::list::npos.

Exceptions

xd::argument_exception

The parameters `indexù is greater than xtd::collections::generic::list::count(). size_type last_index_of(const type_t& value, size_type index) const { return last_index_of(value, index, index + 1); } / Determines the last index of a specific item in the xtd::collections::generic::list <type_t>. /

Parameters

value	The object to locate in the xtd::collections::generic::list <type_t>. /
index	The zero-based starting index of the search. /
count	The number of elements in the section to search /

Returns

Int32 The last index of value if found in the list; otherwise, xtd::collections::generic::list::npos. /

Exceptions

xd::argument_exception

`index` and `count` do not specify a valid section in the xtd::collections::generic::list <type_t>. size_type last_index_of(const type_t& value, size_type index, size_type count) const { if (count < size() || index >= size()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument_out_of_range);; if (index - count > size()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument);;

for (auto i = index; i >= index - (count - 1); –i) if (value == data_->items[i]) return i;

return npos; }

/ Removes the last element of the container. /

Remarks

Calling pop_back on an empty container results in undefined behavior. /

Iterators (including the xtd::collections::generic::list::end() iterator) and references to the last element are invalidated. virtual void pop_back() { ++data_->version; data_->items.pop_back(); }

/ Appends the given element value to the end of the container. /

Parameters

value

The value of the element to append. /

Remarks

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise only the xtd::collections::generic::list::end() iterator is invalidated. /

The new element is initialized as a copy of value. virtual void push_back(const type_t& value) { ++data_->version; data_->items.push_back(value); } / Appends the given element value to the end of the container. /

Parameters

value

The value of the element to append. /

Remarks

If after the operation the new xtd::collections::generic::list::size() is greater than old xtd::collections::generic::list::capacity() a reallocation takes place, in which case all iterators (including the xtd::collections::generic::list::end() iterator) and all references to the elements are invalidated. Otherwise only the xtd::collections::generic::list::end() iterator is invalidated. /

value is moved into the new element. virtual void push_back(type_t&& value) { ++data_->version; data_->items.push_back(std::move(value)); }

/ Removes the first occurrence of a specific object from the xtd::collections::generic::list <type_t>. /

Parameters

item	The object to remove from the xtd::collections::generic::list <type_t>. /

Returns

true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the xtd::collections::generic::list <type_t>. /

Remarks

If type typ_t implements the xtd::iequatable <type_t> generic interface, the equality comparer is the xtd::iequatable::equals method of that interface; otherwise, the default equality comparer is xtd::object::equals. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. bool remove(const type_t& item) override { if (count() == 0) return false; for (auto index = size_type {0}; index < count(); ++index) { if (!helpers::equator<type_t> {}(at(index), item)) continue; remove_at(index); return true; } return false; }

/ Removes all the elements that match the conditions defined by the specified predicate. /

Parameters

match

The xtd::predicate <type_t> delegate that defines the conditions of the elements to search for. /

Returns

The number of elements removed from the xtd::collections::generic::list <type_t>. /

Examples

/ The following example demonstrates the xtd::collections::generic::list::exists method and several other methods that use the xtd::predicate <type_t> generic delegate. /
A xtd::collections::generic::list <type_t> of strings is created, containing 8 dinosaur names, two of which (at positions 1 and 5) end with "saurus". The example also defines a search predicate method named ends_with_saurus, which accepts a string parameter and returns a boolean value indicating whether the input string ends in "saurus". /
The xtd::collections::generic::list::find, xtd::collections::generic::list::find_last, and xtd::collections::generic::list::findA_all methods are used to search the list with the search predicate method, and then the xtd::collections::generic::list::remove_all method is used to remove all entries ending with "saurus". /
Finally, the xtd::collections::generic::list::exists method is called. It traverses the list from the beginning, passing each element in turn to the ends_with_saurus method. The search stops and the method returns true if the ends_with_saurus method returns true for any element. The xtd::collections::generic::list::exists method returns false because all such elements have been removed. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto dinosaurs = list<string> {};
    
    dinosaurs.add("Compsognathus");
    dinosaurs.add("Amargasaurus");
    dinosaurs.add("Oviraptor");
    dinosaurs.add("Velociraptor");
    dinosaurs.add("Deinonychus");
    dinosaurs.add("Dilophosaurus");
    dinosaurs.add("Gallimimus");
    dinosaurs.add("Triceratops");
    
    console::write_line();
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\ntrue_for_all(ends_with_saurus): {0}", dinosaurs.true_for_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind(ends_with_saurus): {0}", dinosaurs.find(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfindLast(ends_with_saurus): {0}", dinosaurs.find_last(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nfind_all(ends_with_saurus):");
    auto sublist = dinosaurs.find_all(predicate<const string&> {ends_with_saurus});
    
    for (const auto& dinosaur : sublist)
      console::write_line(dinosaur);
    
    console::write_line("\n{0} elements removed by remove_all(ends_with_saurus).", dinosaurs.remove_all(predicate<const string&> {ends_with_saurus}));
    
    console::write_line("\nlist now contains:");
    for (const auto& dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nexists(ends_with_saurus): {0}", dinosaurs.exists(predicate<const string&> {ends_with_saurus}));
  }
  
private:
  // Search predicate returns true if a string ends in "saurus".
  static bool ends_with_saurus(const string& s) {
    return s.to_lower().ends_with("saurus");
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// Compsognathus
// Amargasaurus
// Oviraptor
// Velociraptor
// Deinonychus
// Dilophosaurus
// Gallimimus
// Triceratops
//
// true_for_all(ends_with_saurus): false
//
// find(ends_with_saurus): Amargasaurus
//
// findLast(ends_with_saurus): Dilophosaurus
//
// find_all(ends_with_saurus):
// Amargasaurus
// Dilophosaurus
//
// 2 elements removed by remove_all(ends_with_saurus).
//
// list now contains:
// Compsognathus
// Oviraptor
// Velociraptor
// Deinonychus
// Gallimimus
// Triceratops
//
// exists(ends_with_saurus): false

/

Remarks

The xtd::predicate <type_t> is a delegate to a method that returns true if the object passed to it matches the conditions defined in the delegate. The elements of the current xtd::collections::generic::list <type_t> are individually passed to the xtd::predicate <type_t> delegate, and the elements that match the conditions are removed from the xtd::collections::generic::list <type_t>. /

This method performs a linear search; therefore, this method is an O(n) operation, where n is xtd::collections::generic::list::count. xtd::size remove_all(const xtd::predicate<const type_t&>& match) { auto count = xtd::size {0}; auto iterator = data_->items.begin(); while (iterator != data_->items.end()) if (!match(*iterator)) iterator++; else { iterator = data_->items.erase(iterator); ++count; }

if (count) ++data_->version; return count; }

/ Removes the element at the specified index of the xtd::collections::generic::list <type_t>. /

Parameters

index

The zero-based index of the item to remove /

Exceptions

ArgumentOutOfRangeException

index is less than 0 or index is greater than xtd::collections::generic::list::count. void remove_at(size_type index) override { if (index >= count()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument_out_of_range);;

if (index == count() - 1) pop_back(); else erase(begin() + index); }

/ Removes a range of elements from the xtd::collections::generic::list <type_t>. /

Parameters

index	The zero-based index of the item to remove /
count	The number of elements to remove /

Exceptions

xtd::argument_out_of_range_exception

index or count is less than 0 or index + count is greater than xtd::collections::generic::list::count. /

Examples

/ The following code example demonstrates the xtd::collections::generic::list <type_t> constructor and various methods of the xtd::collections::generic::list <type_t> class that act on ranges. An array of strings is created and passed to the constructor, populating the list with the elements of the array. The xtd::collections::generic::list::capacity property is then displayed, to show that the initial capacity is exactly what is required to hold the input elements. /

#include <xtd/xtd>
 
class example {
public:
  static auto main() -> void {
    auto input = array<string> {"Brachiosaurus", "Amargasaurus", "Mamenchisaurus"};
    
    auto dinosaurs = list<string>(input);
    
    console::write_line("\ncapacity: {0}", dinosaurs.capacity());
    
    console::write_line();
    for (auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nadd_range(dinosaurs)");
    dinosaurs.add_range(dinosaurs);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\nremove_range(2, 2)");
    dinosaurs.remove_range(2, 2);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    input = {"Tyrannosaurus", "Deinonychus", "Velociraptor"};
    console::write_line("\ninsert_range(3, input)");
    dinosaurs.insert_range(3, input);
    
    console::write_line();
    for(auto dinosaur : dinosaurs)
      console::write_line(dinosaur);
    
    console::write_line("\noutput = dinosaurs.get_range(2, 3).to_array()");
    auto output = dinosaurs.get_range(2, 3).to_array();
    
    console::write_line();
    for (auto dinosaur : output)
      console::write_line(dinosaur);
  }
};
 
startup_(example::main);
 
// This code produces the following output :
//
//
// capacity: 3
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// add_range(dinosaurs)
//
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
// Brachiosaurus
// Amargasaurus
// Mamenchisaurus
//
// remove_range(2, 2)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Mamenchisaurus
//
// insert_range(3, input)
//
// Brachiosaurus
// Amargasaurus
// Amargasaurus
// Tyrannosaurus
// Deinonychus
// Velociraptor
// Mamenchisaurus
//
// output = dinosaurs.get_range(2, 3).to_array()
//
// Amargasaurus
// Tyrannosaurus
// Deinonychus

/

Remarks

The items are removed and all the elements following them in the xtd::collections::generic::list <type_t> have their indexes reduced by count. virtual void remove_range(size_type index, size_type count) { if (index + count >= this->count()) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::argument_out_of_range);;

erase(begin() + index, begin() + index + count); }

/ Increase the capacity of the vector (the total number of elements that the vector can hold without requiring reallocation) to a value that's greater or equal to new_cap. If new_cap is greater than the current capacity(), new storage is allocated, otherwise the function does nothing. /

Parameters

new_cap

The new capacity of the vector, in number of elements. /

Remarks

xtd::collections::generic::list::reserve does not change the size of the vector. /

If new_cap is greater than xtd::collections::generic::list::capacity property, all iterators, including the xtd::collections::generic::list::end iterator, and all references to the elements are invalidated; otherwise, no iterators or references are invalidated. /

After a call to xtd::collections::generic::list::reserve, insertions will not trigger reallocation unless the insertion would make the size of the vector greater than the value of xtd::collections::generic::list::capacity. virtual void reserve(size_type new_cap) {data_->items.reserve(new_cap);}

/ Resizes the container to contain count elements, does nothing if count == size(). @param count The new size of the container. @remarks If the current size is greater thancount, the container is reduced to its firstcountelements. @remarks If the current size is less thancount`, additional default-inserted elements are appended.

operator const base_type &()

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::operator const base_type & ( ) const

inlinenoexcept

Returns a reference to the underlying base type.

Returns

Reference to the underlying base type.

operator base_type &()

template<class type_t, class allocator_t>

xtd::collections::generic::list< type_t, allocator_t >::operator base_type & ( )

inlinenoexcept

Returns a reference to the underlying base type.

Returns

Reference to the underlying base type.

Member Data Documentation

npos

template<class type_t, class allocator_t>

size_type xtd::collections::generic::list< type_t, allocator_t >::npos

inlinestaticconstexpr

This is a special value equal to the maximum value representable by the type size_type.

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/collections/generic/list.hpp