props (#121)

Author: bitfaster

BitFaster.Caching.UnitTests/Lru/ClassicLruTests.cs

@@ -49,6 +49,12 @@ public void ConstructAddAndRetrieveWithDefaultCtorReturnsValue()
             x.GetOrAdd(1, k => k).Should().Be(1);
         }
 
+        [Fact]
+        public void WhenCtorCapacityArgIs3CapacityIs3()
+        {
+            new ClassicLru<int, int>(3).Capacity.Should().Be(3);
+        }
+
         [Fact]
         public void WhenItemIsAddedCountIsCorrect()
         {

BitFaster.Caching.UnitTests/Lru/ConcurrentLruTests.cs

@@ -69,6 +69,7 @@ public void WhenCapacityIs4HotHasCapacity1AndColdHasCapacity2()
 
             lru.HotCount.Should().Be(1);
             lru.ColdCount.Should().Be(2);
+            lru.Capacity.Should().Be(4);
         }
 
         [Fact]
@@ -83,6 +84,7 @@ public void WhenCapacityIs5HotHasCapacity2AndColdHasCapacity2()
 
             lru.HotCount.Should().Be(2);
             lru.ColdCount.Should().Be(2);
+            lru.Capacity.Should().Be(5);
         }
 
         [Fact]

BitFaster.Caching/ICache.cs

@@ -13,6 +13,16 @@ namespace BitFaster.Caching
     /// <typeparam name="V">The type of values in the cache.</typeparam>
     public interface ICache<K, V>
     {
+        /// <summary>
+        /// Gets the total number of items that can be stored in the cache.
+        /// </summary>
+        int Capacity { get; }
+
+        /// <summary>
+        /// Gets the number of items currently held in the cache.
+        /// </summary>
+        int Count { get; }
+
         /// <summary>
         /// Attempts to get the value associated with the specified key from the cache.
         /// </summary>

BitFaster.Caching/Lru/ClassicLru.cs

@@ -48,8 +48,12 @@ public ClassicLru(int concurrencyLevel, int capacity, IEqualityComparer<K> compa
             this.dictionary = new ConcurrentDictionary<K, LinkedListNode<LruItem>>(concurrencyLevel, this.capacity + 1, comparer);
         }
 
+        ///<inheritdoc/>
         public int Count => this.linkedList.Count;
 
+        ///<inheritdoc/>
+        public int Capacity => this.capacity;
+
         /// <summary>
         /// Gets the ratio of hits to misses, where a value of 1 indicates 100% hits.
         /// </summary>

BitFaster.Caching/Lru/TemplateConcurrentLru.cs

@@ -89,8 +89,12 @@ public TemplateConcurrentLru(
         }
 
         // No lock count: https://arbel.net/2013/02/03/best-practices-for-using-concurrentdictionary/
+        ///<inheritdoc/>
         public int Count => this.dictionary.Skip(0).Count();
 
+        ///<inheritdoc/>
+        public int Capacity => this.coldCapacity + this.warmCapacity + this.hotCapacity;
+
         public int HotCount => this.hotCount;
 
         public int WarmCount => this.warmCount;