Click here to Skip to main content
12,622,675 members (27,767 online)
Click here to Skip to main content
Add your own
alternative version

Tagged as

Stats

17.7K views
11 bookmarked
Posted

Dictionary<string,T>.BestMatch

, 27 Mar 2015 CPOL
Rate this:
Please Sign up or sign in to vote.
Extension methods to select a Dictionary entry using StartsWith

Introduction

I present here two extension methods that allow me to select an item from a Dictionary even if I have only the first part of the key, rather than the whole key.

Background

A few times in the past year, I wanted to select an entry in a Dictionary<string,T> based on only the first part of the key. In early attempts, I added each portion separately; for example if I had a key of "YES", I would also add "Y" and "YE". This became unwieldy as the keys became longer and the benefits of hashing didn't seem as crucial. However, I didn't want to depart from using a Dictionary entirely.

Adding the use of A String.StartsWith that uses a StringComparer[^] to a Dictionary was simple.

The Code

BestMatch will attempt the usual ContainsKey first and only resort to iterating the keys and using StartsWith if the full string isn't found. If it does have to iterate, then it can't stop as soon as it finds a match, it must continue in case it finds a second match.

public static T
BestMatch<T>
(
  this System.Collections.Generic.Dictionary<string,T> Source
,
  string                                               String
)
{
  T result = default(T) ;

  if ( Source.ContainsKey ( String ) )
  {
    result = Source [ String ] ;
  }
  else
  {
    bool found = false ;

    foreach ( string s in Source.Keys )
    {
      if ( s.StartsWith ( String , Source.Comparer ) )
      {
        if ( found )
        {
          throw ( new System.ArgumentException ( "Ambiguous name" , String ) ) ;
        }

        result = Source [ s ] ;

        found = true ;
      }
    }

    if ( !found )
    {
      throw ( new System.ArgumentException ( "Unrecognized name" , String ) ) ;
    }
  }

  return ( result ) ;
}

The second method works similarly to TryParse in that it returns a boolean and the value (or the default for the type) is passed back via an out parameter. If you want to change the name to TryBestMatch or HasBestMatch or something, go ahead.

public static bool
BestMatch<T>
(
  this System.Collections.Generic.Dictionary<string,T> Source
,
  string                                               String
,
  out T                                                Value
)
{
  bool result = true ;

  Value = default(T) ;

  try
  {
    Value = BestMatch ( Source , String ) ;
  }
  catch
  {
    result = false ;
  }

  return ( result ) ;
}

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

PIEBALDconsult
Software Developer (Senior)
United States United States
BSCS 1992 Wentworth Institute of Technology

Originally from the Boston (MA) area. Lived in SoCal for a while. Now in the Phoenix (AZ) area.

OpenVMS enthusiast, ISO 8601 evangelist, photographer, opinionated SOB, acknowledged pedant and contrarian

---------------

"Using fewer technologies is better than using more." -- Rico Mariani

"Good code is its own best documentation. As you’re about to add a comment, ask yourself, ‘How can I improve the code so that this comment isn’t needed?’" -- Steve McConnell

"Every time you write a comment, you should grimace and feel the failure of your ability of expression." -- Unknown

"If you need help knowing what to think, let me know and I'll tell you." -- Jeffrey Snover [MSFT]

"Typing is no substitute for thinking." -- R.W. Hamming

"I find it appalling that you can become a programmer with less training than it takes to become a plumber." -- Bjarne Stroustrup

ZagNut’s Law: Arrogance is inversely proportional to ability.

"Well blow me sideways with a plastic marionette. I've just learned something new - and if I could award you a 100 for that post I would. Way to go you keyboard lovegod you." -- Pete O'Hanlon

"linq'ish" sounds like "inept" in German -- Andreas Gieriet

"Things would be different if I ran the zoo." -- Dr. Seuss

"Wrong is evil, and it must be defeated." –- Jeff Ello

"A good designer must rely on experience, on precise, logical thinking, and on pedantic exactness." -- Nigel Shaw

“It’s always easier to do it the hard way.” -- Blackhart

“If Unix wasn’t so bad that you can’t give it away, Bill Gates would never have succeeded in selling Windows.” -- Blackhart

"Omit needless local variables." -- Strunk... had he taught programming

You may also be interested in...

Comments and Discussions

 
GeneralMy vote of 3 Pin
Paulo Zemek5-Feb-13 5:23
memberPaulo Zemek5-Feb-13 5:23 
GeneralRe: My vote of 3 Pin
PIEBALDconsult5-Feb-13 6:08
memberPIEBALDconsult5-Feb-13 6:08 
GeneralRe: My vote of 3 Pin
Paulo Zemek5-Feb-13 6:29
memberPaulo Zemek5-Feb-13 6:29 
GeneralRe: My vote of 3 Pin
PIEBALDconsult5-Feb-13 6:35
memberPIEBALDconsult5-Feb-13 6:35 
GeneralRe: My vote of 3 Pin
Paulo Zemek5-Feb-13 6:41
memberPaulo Zemek5-Feb-13 6:41 
GeneralRe: My vote of 3 Pin
PIEBALDconsult5-Feb-13 7:17
memberPIEBALDconsult5-Feb-13 7:17 
GeneralRe: My vote of 3 Pin
Paulo Zemek5-Feb-13 7:49
memberPaulo Zemek5-Feb-13 7:49 
GeneralRe: My vote of 3 Pin
PIEBALDconsult6-Feb-13 19:05
memberPIEBALDconsult6-Feb-13 19:05 
QuestionAlternative version? Pin
George Swan2-Feb-13 23:47
memberGeorge Swan2-Feb-13 23:47 
SuggestionRe: Alternative version? Pin
Edo Tzumer3-Feb-13 0:36
memberEdo Tzumer3-Feb-13 0:36 
GeneralRe: Alternative version? Pin
George Swan3-Feb-13 3:23
memberGeorge Swan3-Feb-13 3:23 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.161128.1 | Last Updated 27 Mar 2015
Article Copyright 2013 by PIEBALDconsult
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid