Non-Generic SortedList in CSharp

في المقال ده، هنتكلم عن SortedList، وهو collection فريد من نوعه بيجمع بين مميزات الـ Array والـ Hashtable. هو موجود في System.Collections وبيعتبر Non-Generic.

What is SortedList?

الـ SortedList هو collection من نوع Key/Value pairs، والميزة الأساسية بتاعته إن عناصره دايمًا بتكون مترتبة تصاعديًا على حسب الـ Keys.

ده معناه إنه بيوفرلك طريقتين للوصول للعناصر:

1. عن طريق الـ Key (زي الـ Hashtable).
2. عن طريق الـ Index (زي الـ ArrayList).

Properties of SortedList

• الـ Interfaces: بينفذ الـ interfaces اللي اسمها IEnumerable, ICollection, IDictionary, و ICloneable.
• الـ Internal Structure: من جوه، هو بيحتفظ بـ two arrays: واحد للـ keys وواحد للـ values المرتبطة بيها.
• الـ Key Rules: الـ Key مينفعش يكون null ولازم يكون فريد (unique).
• الـ Value Rules: الـ Value ممكن تكون null أو مكررة عادي.
• الـ Key Type: لازم كل الـ keys في نفس الـ SortedList تكون من نفس نوع البيانات. لو حاولت تضيف key بنوع مختلف، هتاخد Exception.
• الـ Type Safety: بما إنه Non-Generic، فهو بيقبل أي نوع من البيانات في الـ Values لأنه بيتعامل معاها كـ object.

Creating a SortedList

أول حاجة، لازم نعمل using System.Collections;. بعدين بننشئ instance من الـ SortedList.

// Create an empty SortedList
SortedList sortedList = new SortedList();

Adding Elements

بنستخدم Add(key, value) عشان نضيف عناصر، أو ممكن نستخدم طريقة الـ collection-initializer.

SortedList sortedList = new SortedList();
 
// Add elements using the Add() method
sortedList.Add(1, "One");
sortedList.Add(5, "Five");
sortedList.Add(4, "Four");
sortedList.Add(2, "Two");
sortedList.Add(3, "Three");
 
// Note: Elements will be automatically sorted by key: 1, 2, 3, 4, 5
 
// --- Important Rules ---
// Duplicate key will throw an ArgumentException
// sortedList.Add(4, "Another Four"); 
 
// Null value is allowed
sortedList.Add(6, null);
 
// Duplicate value is allowed
sortedList.Add(7, "Five");
 
// Adding a key of a different type (e.g., string) will throw an exception
// sortedList.Add("Ten", "Ten"); 

Accessing Elements

دي واحدة من أقوى مميزات الـ SortedList، لإنك تقدر توصل للعناصر بأكتر من طريقة.

Using Keys

زي الـ Hashtable، بنستخدم الـ indexer [] مع الـ key.

Console.WriteLine($"Key: 1, Value: {sortedList[1]}"); // Outputs: One

Using Index

زي الـ ArrayList، بنستخدم index (اللي بيكون مترتب على حسب الـ keys).

// Get value by its sorted index
Console.WriteLine($"Index: 0, Value: {sortedList.GetByIndex(0)}"); // Outputs: One (because key 1 is at index 0)
 
// Get key by its sorted index
Console.WriteLine($"Index: 0, Key: {sortedList.GetKey(0)}"); // Outputs: 1

Using Loops

• الـ foreach loop: بيلف على العناصر كـ DictionaryEntry.
• الـ for loop: مناسب جدًا هنا لإننا نقدر نستخدم الـ index.

// Using a foreach loop
Console.WriteLine("\nAccessing with foreach loop:");
foreach (DictionaryEntry item in sortedList)
{
    Console.WriteLine($"Key: {item.Key}, Value: {item.Value}");
}
 
// Using a for loop
Console.WriteLine("\nAccessing with for loop:");
for (int i = 0; i < sortedList.Count; i++)
{
    Console.WriteLine($"Key: {sortedList.GetKey(i)}, Value: {sortedList.GetByIndex(i)}");
}

Removing Elements

• الـ Remove(key): بتحذف العنصر بالـ key بتاعه.
• الـ RemoveAt(index): بتحذف العنصر بالـ index بتاعه (بعد الترتيب).
• الـ Clear(): بتحذف كل العناصر.

// Remove element with key "USA"
sortedList.Remove("USA");
 
// Remove element at index 1 (after sorting)
sortedList.RemoveAt(1);
 
// Clear all elements
sortedList.Clear();
Console.WriteLine($"Total elements after Clear(): {sortedList.Count}"); // Outputs: 0

Checking for Availability

• الـ Contains(key) أو ContainsKey(key): بتتأكد لو فيه key معين موجود.
• الـ ContainsValue(value): بتتأكد لو فيه value معينة موجودة.

Console.WriteLine("Does key 'Ind' exist? " + sortedList.ContainsKey("Ind"));      // True
Console.WriteLine("Does value 'India' exist? " + sortedList.ContainsValue("India")); // True

Other Useful Methods and Properties

• الـ Clone(): بتعمل shallow copy من الـ SortedList.
• الـ CopyTo(array, index): بتنسخ عناصر الـ SortedList لـ array عادية. ممكن كمان تنسخ الـ Keys بس أو الـ Values بس.

  sortedList.Keys.CopyTo(myKeysArray, 0);
  sortedList.Values.CopyTo(myValuesArray, 0);

• Properties:
  • الـ Keys: بترجع collection فيها كل الـ keys.
  • الـ Values: بترجع collection فيها كل الـ values.
  • الـ Count: بترجع عدد العناصر.
  • الـ Capacity: بترجع السعة التخزينية الحالية.

When to Use SortedList?

الـ SortedList أداة قوية، لكن لازم نفهم إنها بتدفع تمن الترتيب ده. مع كل عملية إضافة أو حذف، الـ collection بتحتاج تعيد ترتيب نفسها عشان تفضل مترتبة. ده بيخليها مكلفة في الأداء (expensive) لو بنتعامل مع عدد كبير جدًا من العناصر.

الخلاصة:

• استخدم SortedList: لما تكون بتتعامل مع collections صغيرة ومحتاجها تفضل مترتبة دايمًا، ومحتاج توصل للعناصر بالـ key والـ index.
• تجنب SortedList: لو بتتعامل مع collections كبيرة جدًا والبيانات بتتغير باستمرار. في الحالة دي، الأفضل تستخدم Dictionary أو HashSet، أو حتى List عادية وترتبها وقت ما تحتاج بس باستخدام Sort().

نصيحة: الـ SortedList هو non-generic، وللأكواد الحديثة اللي بتهتم بالـ type-safety والأداء، يُفضل استخدام البديل الـ generic وهو SortedList<TKey, TValue>.